{"items":[{"type":"link","label":"Provisioning API","link":"/docs/provisioning-api/api-reference/provisioning-api-1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1","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.91)","showPageActions":true}],"sectionId":"/docs/provisioning-api/api-reference/provisioning-api-1"}]}]}},{"type":"separator","label":"Webhook","content":null},{"type":"group","label":"Webhooks","link":"/docs/provisioning-api/api-reference/provisioning-api-1/webhooks","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/webhooks/webhookcontroller_listwebhooks_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/webhooks/webhookcontroller_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":"WebhookController_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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_717","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_717"}],"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/webhookcontroller_listwebhooks_v1","openApiOperationId":"WebhookController_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":"schema_718"}},"schemaId":"schema_718"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_718"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookcontroller_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-1/webhooks/webhookcontroller_createwebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/webhooks/webhookcontroller_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":"WebhookController_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_716","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_716"}],"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/webhookcontroller_createwebhook_v1","openApiOperationId":"WebhookController_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":"schema_721"}},"schemaId":"schema_721"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}},"schemaId":"schema_722"},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}},"schemaId":"schema_723"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_721","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_721"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"409","schemaId":"schema_722","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}}},{"code":"424","schemaId":"schema_723","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookcontroller_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-1/webhooks/webhookcontroller_getwebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/webhooks/webhookcontroller_getwebhook_v1","metadata":{"seo":{"title":"Get webhook","description":"Return an already created webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookController_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_716","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_716","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_716"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_716"}],"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/webhookcontroller_getwebhook_v1","openApiOperationId":"WebhookController_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":"schema_724"}},"schemaId":"schema_724"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}},"schemaId":"schema_725"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_724","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_724"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_725","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookcontroller_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-1/webhooks/webhookcontroller_deletewebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/webhooks/webhookcontroller_deletewebhook_v1","metadata":{"seo":{"title":"Delete webhook","description":"Deletes an already created webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookController_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_716","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_716","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_716"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_716"}],"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/webhookcontroller_deletewebhook_v1","openApiOperationId":"WebhookController_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":"schema_724"}},"schemaId":"schema_724"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}},"schemaId":"schema_725"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_724","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_724"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_725","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookcontroller_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-1/webhooks/webhookcontroller_replacewebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/webhooks/webhookcontroller_replacewebhook_v1","metadata":{"seo":{"title":"Replace webhook","description":"Replace an already existing webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookController_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_716","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_716","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_716"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_716"}],"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/webhookcontroller_replacewebhook_v1","openApiOperationId":"WebhookController_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":"schema_726"}},"schemaId":"schema_726"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}},"schemaId":"schema_725"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}},"schemaId":"schema_722"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_726","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_726"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_725","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}}},{"code":"409","schemaId":"schema_722","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookcontroller_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-1/webhooks/webhookcontroller_updatewebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/webhooks/webhookcontroller_updatewebhook_v1","metadata":{"seo":{"title":"Update webhook","description":"Update an already existing webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookController_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_716","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_716","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_716"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_716"}],"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/webhookcontroller_updatewebhook_v1","openApiOperationId":"WebhookController_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":"schema_726"}},"schemaId":"schema_726"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}},"schemaId":"schema_725"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}},"schemaId":"schema_722"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_726","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_726"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_725","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}}},{"code":"409","schemaId":"schema_722","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookcontroller_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/webhookcontroller_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/webhookcontroller_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/webhookcontroller_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/webhookcontroller_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/webhookcontroller_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/webhookcontroller_updatewebhook_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"WhatsApp","content":null},{"type":"group","label":"WhatsApp Accounts","link":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-accounts","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/whatsapp-accounts/accountscontroller_getaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-accounts/accountscontroller_getaccount_v1","metadata":{"seo":{"title":"Get account for project","description":"Returns an account for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AccountsController_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_716","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_716"}],"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/accountscontroller_getaccount_v1","openApiOperationId":"AccountsController_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":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}},"schemaId":"schema_728"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}}},{"code":"409","schemaId":"schema_728","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/accountscontroller_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-1/whatsapp-accounts/accountscontroller_createaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-accounts/accountscontroller_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":"AccountsController_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_716","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_729","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_729","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_716"}],"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_729","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/accountscontroller_createaccount_v1","openApiOperationId":"AccountsController_createAccount_v1","summary":"Create account for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"schema_729","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_729","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":"schema_730"}},"schemaId":"schema_730"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_732"}},"schemaId":"schema_732"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_730","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_730"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}},{"code":"409","schemaId":"schema_732","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_732"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_736","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_736","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_736","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_737","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_737","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_737","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_738","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_738","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_738","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_739","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_739","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_739","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_740","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_740","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_740","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_741","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_741","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_741","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/accountscontroller_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-1/whatsapp-accounts/accountscontroller_deleteaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-accounts/accountscontroller_deleteaccount_v1","metadata":{"seo":{"title":"Delete account for project","description":"Deletes the account for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AccountsController_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_716","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_716"}],"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/accountscontroller_deleteaccount_v1","openApiOperationId":"AccountsController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}},"schemaId":"schema_743"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_744"}},"schemaId":"schema_744"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"409","schemaId":"schema_743","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}}},{"code":"500","schemaId":"schema_744","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_744"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/accountscontroller_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-1/whatsapp-accounts/accountscontroller_updateaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-accounts/accountscontroller_updateaccount_v1","metadata":{"seo":{"title":"Update account for project","description":"Update an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AccountsController_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_716","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_716"}],"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/accountscontroller_updateaccount_v1","openApiOperationId":"AccountsController_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":"schema_745"}},"schemaId":"schema_745"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_746"}},"schemaId":"schema_746"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_745","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_745"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}}},{"code":"409","schemaId":"schema_746","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_746"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/accountscontroller_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-1/whatsapp-accounts/accountscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-accounts/accountscontroller_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":"AccountsController_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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"}],"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/accountscontroller_listactivities_v1","openApiOperationId":"AccountsController_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":"schema_748"}},"schemaId":"schema_748"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_748","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_748"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/accountscontroller_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-1/whatsapp-accounts/accountscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-accounts/accountscontroller_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":"AccountsController_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_716","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_716"}],"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/accountscontroller_createcomment_v1","openApiOperationId":"AccountsController_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":"schema_749"}},"schemaId":"schema_749"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}},"schemaId":"schema_728"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_749","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}}},{"code":"409","schemaId":"schema_728","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/accountscontroller_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/accountscontroller_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/accountscontroller_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/accountscontroller_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/accountscontroller_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/accountscontroller_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/accountscontroller_createcomment_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp","link":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/whatsapp/templateanalyticshelperscontroller_enabletemplateanalytics_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp/templateanalyticshelperscontroller_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":"TemplateAnalyticsHelpersController_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_716","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_716"}],"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/templateanalyticshelperscontroller_enabletemplateanalytics_v1","openApiOperationId":"TemplateAnalyticsHelpersController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_750"}},"schemaId":"schema_750"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"424","schemaId":"schema_750","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_750"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/templateanalyticshelperscontroller_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-1/whatsapp/embeddedsignuphelpercontroller_createlonglivedaccesstoken_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp/embeddedsignuphelpercontroller_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":"EmbeddedSignupHelperController_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_716","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_716"}],"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/embeddedsignuphelpercontroller_createlonglivedaccesstoken_v1","openApiOperationId":"EmbeddedSignupHelperController_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":"schema_751"}},"schemaId":"schema_751"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}},"schemaId":"schema_752"}],"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":"schema_751","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_751"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"500","schemaId":"schema_752","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/embeddedsignuphelpercontroller_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-1/whatsapp/embeddedsignuphelpercontroller_listwabadetailsfortoken_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp/embeddedsignuphelpercontroller_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":"EmbeddedSignupHelperController_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_716","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_716"}],"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/embeddedsignuphelpercontroller_listwabadetailsfortoken_v1","openApiOperationId":"EmbeddedSignupHelperController_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":"schema_753"}},"schemaId":"schema_753"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}},"schemaId":"schema_752"}],"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":"schema_753","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_753"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"500","schemaId":"schema_752","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/embeddedsignuphelpercontroller_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/templateanalyticshelperscontroller_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/embeddedsignuphelpercontroller_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/embeddedsignuphelpercontroller_listwabadetailsfortoken_v1","deprecated":true}]}]}]}]}},{"type":"group","label":"WhatsApp Flows","link":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-flows","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/whatsapp-flows/flowscontroller_listflows_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-flows/flowscontroller_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":"FlowsController_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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"}],"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/flowscontroller_listflows_v1","openApiOperationId":"FlowsController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-flows/flowscontroller_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-1/whatsapp-flows/flowscontroller_listflowscreens_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-flows/flowscontroller_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":"FlowsController_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_716","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_716","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_716"},{"name":"flowId","in":"path","required":true,"schemaId":"schema_716"}],"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/flowscontroller_listflowscreens_v1","openApiOperationId":"FlowsController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_754"}},"schemaId":"schema_754"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_754","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_754"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-flows/flowscontroller_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/flowscontroller_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/flowscontroller_listflowscreens_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Senders","link":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/whatsapp-senders/senderscontroller_listsenders_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","description":"The page size requested."},{"name":"filterStates","in":"query","schemaId":"schema_755","description":"Optionally query for sender by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_756","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_755"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_756"}],"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/senderscontroller_listsenders_v1","openApiOperationId":"SendersController_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":"schema_757"}},"schemaId":"schema_757"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_757","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_757"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_createsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_759","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_759","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_716"}],"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_759","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/senderscontroller_createsender_v1","openApiOperationId":"SendersController_createSender_v1","summary":"Create sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"schema_759","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_759","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":"schema_760"}},"schemaId":"schema_760"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_761"}},"schemaId":"schema_761"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}},"schemaId":"schema_752"}],"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":"schema_760","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_760"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}},{"code":"409","schemaId":"schema_761","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_761"}}},{"code":"500","schemaId":"schema_752","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_762","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_762","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_762","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_763","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_763","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_763","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_764","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_764","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_764","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_765","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_765","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_765","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_766","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_766","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_766","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_767","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_767","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_767","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_768","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_768","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_768","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_769","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_769","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_769","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_770","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_770","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_770","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 username updated","description":"\n        Received when a sender username is updated.\n        ","callbackName":"UsernameUpdate","callbackId":"UsernameUpdate/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_771","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_771","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdate/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/UsernameUpdate/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"UsernameUpdate/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_771","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdate/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_get_v1","metadata":{"seo":{"title":"Get sender for project","description":"Returns a sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_get_v1","openApiOperationId":"SendersController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_delete_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_delete_v1","openApiOperationId":"SendersController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_772"}},"schemaId":"schema_772"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_772","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_772"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_update_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_update_v1","metadata":{"seo":{"title":"Updates a sender in project","description":"Updates a sender in project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendersController_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.\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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_update_v1","openApiOperationId":"SendersController_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":"schema_773"}},"schemaId":"schema_773"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_774"}},"schemaId":"schema_774"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_773","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_773"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_774","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_774"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_762","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_762","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_762","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_763","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_763","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_763","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_764","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_764","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_764","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_765","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_765","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_765","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_766","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_766","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_766","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_767","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_767","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_767","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_768","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_768","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_768","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_769","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_769","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_769","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_770","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_770","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_770","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 username updated","description":"\n        Received when a sender username is updated.\n        ","callbackName":"UsernameUpdate","callbackId":"UsernameUpdate/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_771","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_771","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdate/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/UsernameUpdate/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"UsernameUpdate/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_771","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdate/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"}],"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/senderscontroller_listactivities_v1","openApiOperationId":"SendersController_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":"schema_775"}},"schemaId":"schema_775"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_775","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_775"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_deletechanges_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_deletechanges_v1","openApiOperationId":"SendersController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}},"schemaId":"schema_776"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_777"}},"schemaId":"schema_777"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}}},{"code":"409","schemaId":"schema_777","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_777"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_createcomment_v1","openApiOperationId":"SendersController_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":"schema_778"}},"schemaId":"schema_778"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_778","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_778"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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-1/whatsapp-senders/senderscontroller_register_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_register_v1","openApiOperationId":"SendersController_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":"schema_779"}},"schemaId":"schema_779"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_780"}},"schemaId":"schema_780"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_781"}},"schemaId":"schema_781"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_779","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_779"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_780","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_780"}}},{"code":"429","schemaId":"schema_781","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_781"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_register_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/register"},{"label":"Verify sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_verify_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_verify_v1","openApiOperationId":"SendersController_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":"schema_782"}},"schemaId":"schema_782"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_783"}},"schemaId":"schema_783"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_782","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_782"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_783","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_783"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_register_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/senderscontroller_verify_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Solutions","link":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-solutions","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/whatsapp-solutions/solutionscontroller_listsolutions_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-solutions/solutionscontroller_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":"SolutionsController_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_716","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_716"}],"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/solutionscontroller_listsolutions_v1","openApiOperationId":"SolutionsController_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":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/solutionscontroller_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-1/whatsapp-solutions/solutionscontroller_createsolution_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-solutions/solutionscontroller_createsolution_v1","metadata":{"seo":{"title":"Create solution for project","description":"Returns all solutions for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SolutionsController_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_716","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_716"}],"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/solutionscontroller_createsolution_v1","openApiOperationId":"SolutionsController_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":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/solutionscontroller_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-1/whatsapp-solutions/solutionscontroller_getsolution_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-solutions/solutionscontroller_getsolution_v1","metadata":{"seo":{"title":"Get solution for project","description":"Returns a solution for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SolutionsController_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_716","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_716","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_716"},{"name":"solutionId","in":"path","required":true,"schemaId":"schema_716"}],"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/solutionscontroller_getsolution_v1","openApiOperationId":"SolutionsController_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":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}},"schemaId":"schema_784"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_784","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/solutionscontroller_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-1/whatsapp-solutions/solutionscontroller_assignsolution_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-solutions/solutionscontroller_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":"SolutionsController_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_716","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_716","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_716"},{"name":"solutionId","in":"path","required":true,"schemaId":"schema_716"}],"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/solutionscontroller_assignsolution_v1","openApiOperationId":"SolutionsController_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":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}},"schemaId":"schema_784"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_785"}},"schemaId":"schema_785"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_784","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}}},{"code":"409","schemaId":"schema_785","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_785"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/solutionscontroller_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/solutionscontroller_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/solutionscontroller_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/solutionscontroller_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/solutionscontroller_assignsolution_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Templates","link":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/whatsapp-templates/templatescontroller_listtemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_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":"TemplatesController_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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_786","description":"The page size requested."},{"name":"fieldMask","in":"query","schemaId":"schema_787","description":"Field masks are a way for API callers to list the fields that a request should return."},{"name":"filterStates","in":"query","schemaId":"schema_788","description":"Optionally query for sender by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_789","description":"Optionally query for sender by statuses."},{"name":"templateAnalyticsDateRange","in":"query","schemaId":"schema_790","description":"The date range to retrieve template analytics for. Fallback to DAY if none is set."},{"name":"templateName","in":"query","schemaId":"schema_716","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_786"},{"name":"fieldMask","in":"query","required":false,"schemaId":"schema_787"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_788"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_789"},{"name":"templateAnalyticsDateRange","in":"query","required":false,"schemaId":"components/schemas/WhatsappTemplateAnalyticsDateRangesEnum"},{"name":"templateName","in":"query","required":false,"schemaId":"schema_716"}],"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/templatescontroller_listtemplates_v1","openApiOperationId":"TemplatesController_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_791"}},"schemaId":"schema_791"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_792"}},"schemaId":"schema_792"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_791","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_791"}}},{"code":"400","schemaId":"schema_792","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_792"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_createtemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_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":"TemplatesController_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_716","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/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/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_716"}],"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/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/templatescontroller_createtemplate_v1","openApiOperationId":"TemplatesController_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/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/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":"schema_793"}},"schemaId":"schema_793"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_794"}},"schemaId":"schema_794"},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}},"schemaId":"schema_795"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}},"schemaId":"schema_796"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_797"}},"schemaId":"schema_797"}],"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":"schema_793","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_793"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"409","schemaId":"schema_794","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_794"}}},{"code":"424","schemaId":"schema_795","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}}},{"code":"429","schemaId":"schema_796","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}}},{"code":"500","schemaId":"schema_797","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_797"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_798","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_798","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_798","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_799","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_799","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_799","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_800","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_800","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_800","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_801","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_801","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_801","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_802","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_802","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_802","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_803","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_803","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_803","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_804","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_804","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_804","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_805","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_805","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_805","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/templatescontroller_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-1/whatsapp-templates/templatescontroller_listtemplatesbyname_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_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":"TemplatesController_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_716","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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_786","description":"The page size requested."},{"name":"fieldMask","in":"query","schemaId":"schema_787","description":"Field masks are a way for API callers to list the fields that a request should return."},{"name":"templateAnalyticsDateRange","in":"query","schemaId":"schema_790","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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_786"},{"name":"fieldMask","in":"query","required":false,"schemaId":"schema_787"},{"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/templatescontroller_listtemplatesbyname_v1","openApiOperationId":"TemplatesController_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_791"}},"schemaId":"schema_791"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_806"}},"schemaId":"schema_806"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_791","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_791"}}},{"code":"400","schemaId":"schema_806","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_806"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_deletetemplatesbyname_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_deletetemplatesbyname_v1","metadata":{"seo":{"title":"Delete template by name","description":"Delete template that matches the name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TemplatesController_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_716","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_716","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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"}],"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}/whatsapp/templates/{templateName}","href":"whatsapp-templates/templatescontroller_deletetemplatesbyname_v1","openApiOperationId":"TemplatesController_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":"schema_808"}},"schemaId":"schema_808"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}},"schemaId":"schema_796"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_808","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_808"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"429","schemaId":"schema_796","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_gettemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_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":"TemplatesController_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_716","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_716","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_809","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_787","description":"Field masks are a way for API callers to list the fields that a request should return."},{"name":"templateAnalyticsDateRange","in":"query","schemaId":"schema_790","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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguages"}],"query":[{"name":"fieldMask","in":"query","required":false,"schemaId":"schema_787"},{"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/templatescontroller_gettemplate_v1","openApiOperationId":"TemplatesController_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_810"}},"schemaId":"schema_810"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_811"}},"schemaId":"schema_811"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_810","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_810"}}},{"code":"400","schemaId":"schema_811","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_811"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_deletetemplatebynameandlanguage_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_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":"TemplatesController_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_716","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_716","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_809","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_812","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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguages"}],"query":[{"name":"deleteSubmitted","in":"query","required":false,"schemaId":"schema_812"}],"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/templatescontroller_deletetemplatebynameandlanguage_v1","openApiOperationId":"TemplatesController_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":"schema_808"}},"schemaId":"schema_808"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_813"}},"schemaId":"schema_813"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_814"}},"schemaId":"schema_814"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_808","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_808"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_813","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_813"}}},{"code":"409","schemaId":"schema_814","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_814"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_updatetemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_updatetemplate_v1","metadata":{"seo":{"title":"Update a template in project","description":"Updates a template DRAFT."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TemplatesController_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_716","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_716","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_809","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"]}},"schemaId":"components/schemas/WhatsappUpdateTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value"],"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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguages"}],"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"]}},"responseCodes":["200","400","401","404","409","424","429","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","href":"whatsapp-templates/templatescontroller_updatetemplate_v1","openApiOperationId":"TemplatesController_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"],"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"]}},"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":"schema_815"}},"schemaId":"schema_815"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_816"}},"schemaId":"schema_816"},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}},"schemaId":"schema_795"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}},"schemaId":"schema_796"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_797"}},"schemaId":"schema_797"}],"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":"schema_815","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_815"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"409","schemaId":"schema_816","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_816"}}},{"code":"424","schemaId":"schema_795","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}}},{"code":"429","schemaId":"schema_796","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}}},{"code":"500","schemaId":"schema_797","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_797"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_798","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_798","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_798","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_799","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_799","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_799","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_800","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_800","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_800","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_801","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_801","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_801","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_802","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_802","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_802","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_803","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_803","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_803","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_804","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_804","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_804","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_805","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_805","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_805","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/templatescontroller_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-1/whatsapp-templates/templatescontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_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":"TemplatesController_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_716","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_716","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_809","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguages"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"}],"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/templatescontroller_listactivities_v1","openApiOperationId":"TemplatesController_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":"schema_817"}},"schemaId":"schema_817"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_817","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_817"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_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":"TemplatesController_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_716","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_716","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_809","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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguages"}],"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","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/comments","href":"whatsapp-templates/templatescontroller_createcomment_v1","openApiOperationId":"TemplatesController_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":"schema_818"}},"schemaId":"schema_818"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_818","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_818"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_comparetemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_comparetemplates_v1","metadata":{"seo":{"title":"Compare two templates","description":"Compare two templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TemplatesController_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_716","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_716","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_809","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_716"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_716"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguages"}],"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/templatescontroller_comparetemplates_v1","openApiOperationId":"TemplatesController_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":"schema_819"}},"schemaId":"schema_819"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820"}},"schemaId":"schema_820"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_821"}},"schemaId":"schema_821"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_819","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_819"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_820","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820"}}},{"code":"409","schemaId":"schema_821","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_821"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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-1/whatsapp-templates/templatescontroller_synctemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/whatsapp-templates/templatescontroller_synctemplates_v1","metadata":{"seo":{"title":"Synchronize templates for project","description":"Synchronize templates for project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TemplatesController_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_716","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_716"}],"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","429","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/sync","href":"whatsapp-templates/templatescontroller_synctemplates_v1","openApiOperationId":"TemplatesController_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":"schema_742"}},"schemaId":"schema_742"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_822"}},"schemaId":"schema_822"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"schema_742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_742"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"429","schemaId":"schema_822","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_822"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_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/templatescontroller_synctemplates_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"Bundles","content":null},{"type":"group","label":"Bundles","link":"/docs/provisioning-api/api-reference/provisioning-api-1/bundles","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/bundles/bundlescontroller_list_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/bundles/bundlescontroller_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":"BundlesController_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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_823","description":"The page size requested."},{"name":"filterConvAppIds","in":"query","schemaId":"schema_824","description":"Optional query for filtering by Conversation App IDs."},{"name":"filterSmsAppIds","in":"query","schemaId":"schema_824","description":"Optional query for filtering by SMS App IDs."},{"name":"filterStates","in":"query","schemaId":"schema_825","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_823"},{"name":"filterConvAppIds","in":"query","required":false,"schemaId":"schema_824"},{"name":"filterSmsAppIds","in":"query","required":false,"schemaId":"schema_824"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_825"}],"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/bundlescontroller_list_v1","openApiOperationId":"BundlesController_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":"schema_826"}},"schemaId":"schema_826"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_826","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_826"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundles/bundlescontroller_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-1/bundles/bundlescontroller_create_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/bundles/bundlescontroller_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":"BundlesController_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_716","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_827","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_827","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_716"}],"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_827","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/bundlescontroller_create_v1","openApiOperationId":"BundlesController_create_v1","summary":"Create bundle for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"schema_827","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_827","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":"schema_828"}},"schemaId":"schema_828"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_829"}},"schemaId":"schema_829"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_830"}},"schemaId":"schema_830"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_831"}},"schemaId":"schema_831"},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}},"schemaId":"schema_723"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_832"}},"schemaId":"schema_832"}],"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":"schema_828","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_828"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"403","schemaId":"schema_829","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_829"}}},{"code":"404","schemaId":"schema_830","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_830"}}},{"code":"409","schemaId":"schema_831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_831"}}},{"code":"424","schemaId":"schema_723","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}}},{"code":"500","schemaId":"schema_832","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_832"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_833","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_833","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_833","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundles/bundlescontroller_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-1/bundles/bundlescontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/bundles/bundlescontroller_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":"BundlesController_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_716","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_716","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_716"},{"name":"bundleId","in":"path","required":true,"schemaId":"schema_716"}],"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/bundlescontroller_get_v1","openApiOperationId":"BundlesController_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":"schema_834"}},"schemaId":"schema_834"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_835"}},"schemaId":"schema_835"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_834","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_834"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_835","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_835"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundles/bundlescontroller_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/bundlescontroller_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/bundlescontroller_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/bundlescontroller_get_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"KakaoTalk","content":null},{"type":"group","label":"KakaoTalk Categories","link":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-categories","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/kakaotalk-categories/categoriescontroller_listsendercategories_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-categories/categoriescontroller_listsendercategories_v1","metadata":{"seo":{"title":"List all sender categories.","description":"Returns a list of sender categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CategoriesController_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_716","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_716"}],"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/categoriescontroller_listsendercategories_v1","openApiOperationId":"CategoriesController_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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-categories/categoriescontroller_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-1/kakaotalk-categories/categoriescontroller_gettemplatecategories_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-categories/categoriescontroller_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":"CategoriesController_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_716","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_716","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_747","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"}],"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/categoriescontroller_gettemplatecategories_v1","openApiOperationId":"CategoriesController_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":"schema_837"}},"schemaId":"schema_837"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_837","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_837"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-categories/categoriescontroller_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/categoriescontroller_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/categoriescontroller_gettemplatecategories_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"KakaoTalk Senders","link":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-senders","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/kakaotalk-senders/kakaotalksenderscontroller_listsenders_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","description":"The page size requested."},{"name":"filterStates","in":"query","schemaId":"schema_838","description":"Optionally query for sender by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_839","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_838"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_839"}],"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":"schema_840"}},"schemaId":"schema_840"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_840","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_840"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/kakaotalk-senders/kakaotalksenderscontroller_createsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716"}],"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":"schema_841"}},"schemaId":"schema_841"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_842"}},"schemaId":"schema_842"},{"code":"412","description":"PreconditionFailed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_843"}},"schemaId":"schema_843"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_841","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_841"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}},{"code":"409","schemaId":"schema_842","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_842"}}},{"code":"412","schemaId":"schema_843","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_843"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_844","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_844","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_844","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_845","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_845","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_845","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_846","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_846","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_846","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_847","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_847","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_847","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-1/kakaotalk-senders/senderscontroller_getsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-senders/senderscontroller_getsender_v1","metadata":{"seo":{"title":"Get sender for project","description":"Returns a sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendersController_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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_getsender_v1","openApiOperationId":"SendersController_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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/senderscontroller_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-1/kakaotalk-senders/senderscontroller_deletesender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_deletesender_v1","openApiOperationId":"SendersController_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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_848"}},"schemaId":"schema_848"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_848","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_848"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/senderscontroller_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-1/kakaotalk-senders/senderscontroller_updatesender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_updatesender_v1","openApiOperationId":"SendersController_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":"schema_849"}},"schemaId":"schema_849"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_850"}},"schemaId":"schema_850"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_851"}},"schemaId":"schema_851"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_849","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_849"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_850","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_850"}}},{"code":"409","schemaId":"schema_851","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_851"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/senderscontroller_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-1/kakaotalk-senders/kakaotalksenderscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_747","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"}],"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":"schema_852"}},"schemaId":"schema_852"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_852","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_852"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/kakaotalk-senders/kakaotalksenderscontroller_deletechanges_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}},"schemaId":"schema_776"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_853"}},"schemaId":"schema_853"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}}},{"code":"409","schemaId":"schema_853","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_853"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/kakaotalk-senders/kakaotalksenderscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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":"schema_854"}},"schemaId":"schema_854"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_854","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_854"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/kakaotalk-senders/senderscontroller_registersender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-senders/senderscontroller_registersender_v1","metadata":{"seo":{"title":"Register sender for project","description":"Requests sender registration for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendersController_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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_registersender_v1","openApiOperationId":"SendersController_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":"schema_855"}},"schemaId":"schema_855"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_856"}},"schemaId":"schema_856"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_855","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_855"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_856","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_856"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/senderscontroller_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-1/kakaotalk-senders/senderscontroller_verifysender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_verifysender_v1","openApiOperationId":"SendersController_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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_857"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_verifysender_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"KakaoTalk Templates","link":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-templates","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/kakaotalk-templates/kakaotalktemplatescontroller_listtemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_858","description":"Optionally query for template by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_859","description":"Optionally query for template by statuses."},{"name":"pageSize","in":"query","schemaId":"schema_786","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_716","description":"The page token if retrieving the next page from a previous query."},{"name":"templateName","in":"query","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"query":[{"name":"filterStates","in":"query","required":false,"schemaId":"schema_858"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_859"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_786"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"templateName","in":"query","required":false,"schemaId":"schema_716"}],"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":"schema_837"}},"schemaId":"schema_837"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_837","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_837"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/kakaotalk-templates/kakaotalktemplatescontroller_createtemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"}],"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":"schema_861"}},"schemaId":"schema_861"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_862"}},"schemaId":"schema_862"},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_863"}},"schemaId":"schema_863"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_864"}},"schemaId":"schema_864"}],"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":"schema_861","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_861"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"409","schemaId":"schema_862","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_862"}}},{"code":"424","schemaId":"schema_863","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_863"}}},{"code":"500","schemaId":"schema_864","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_864"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_865","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_865","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_865","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_866","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_866","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_866","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_867","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_867","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_867","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-1/kakaotalk-templates/templatescontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-templates/templatescontroller_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":"TemplatesController_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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_716"}],"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/templatescontroller_get_v1","openApiOperationId":"TemplatesController_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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/templatescontroller_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-1/kakaotalk-templates/templatescontroller_deletetemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-templates/templatescontroller_deletetemplate_v1","metadata":{"seo":{"title":"Delete template for project","description":"Delete template that matches the template code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TemplatesController_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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_716"}],"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/templatescontroller_deletetemplate_v1","openApiOperationId":"TemplatesController_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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_868"}},"schemaId":"schema_868"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_868","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_868"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/templatescontroller_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-1/kakaotalk-templates/kakaotalktemplatescontroller_updatetemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_716"}],"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":"schema_869"}},"schemaId":"schema_869"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_870"}},"schemaId":"schema_870"},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_863"}},"schemaId":"schema_863"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_869","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_869"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}}},{"code":"409","schemaId":"schema_870","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_870"}}},{"code":"424","schemaId":"schema_863","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_863"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/kakaotalk-templates/kakaotalktemplatescontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_716","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_747","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_716"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"}],"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":"schema_852"}},"schemaId":"schema_852"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_852","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_852"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_860"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/kakaotalk-templates/templatescontroller_deletetemplatedraft_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/kakaotalk-templates/templatescontroller_deletetemplatedraft_v1","metadata":{"seo":{"title":"Delete template draft for project","description":"Delete a template draft."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TemplatesController_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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_716"}],"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/templatescontroller_deletetemplatedraft_v1","openApiOperationId":"TemplatesController_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":"schema_836"}},"schemaId":"schema_836"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_871"}},"schemaId":"schema_871"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_836","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_836"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"409","schemaId":"schema_871","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_871"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/templatescontroller_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-1/kakaotalk-templates/kakaotalktemplatescontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_716","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_716"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_716"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_716"}],"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":"schema_872"}},"schemaId":"schema_872"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_872","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_872"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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/templatescontroller_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/templatescontroller_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/templatescontroller_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-1/conversation","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/conversation/instagramcontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/conversation/instagramcontroller_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":"InstagramController_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_716","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_716","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_716"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_716"}],"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/instagramcontroller_get_v1","openApiOperationId":"InstagramController_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":"schema_873"}},"schemaId":"schema_873"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_874"}},"schemaId":"schema_874"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_875"}},"schemaId":"schema_875"}],"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":"schema_873","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_873"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_874","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_874"}}},{"code":"500","schemaId":"schema_875","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_875"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/instagramcontroller_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-1/conversation/messengercontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/conversation/messengercontroller_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":"MessengerController_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_716","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_716","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_716"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_716"}],"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/messengercontroller_get_v1","openApiOperationId":"MessengerController_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":"schema_873"}},"schemaId":"schema_873"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_876"}},"schemaId":"schema_876"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_875"}},"schemaId":"schema_875"}],"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":"schema_873","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_873"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_876","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_876"}}},{"code":"500","schemaId":"schema_875","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_875"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/messengercontroller_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-1/conversation/telegramcontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/conversation/telegramcontroller_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":"TelegramController_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_716","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_716","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_716"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_716"}],"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/telegramcontroller_get_v1","openApiOperationId":"TelegramController_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":"schema_873"}},"schemaId":"schema_873"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_878"}},"schemaId":"schema_878"}],"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":"schema_873","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_873"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_877"}}},{"code":"500","schemaId":"schema_878","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_878"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/telegramcontroller_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-1/conversation/vibercontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/conversation/vibercontroller_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":"ViberController_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_716","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_716","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_716"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_716"}],"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/vibercontroller_get_v1","openApiOperationId":"ViberController_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":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_879"}},"schemaId":"schema_879"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_880"}},"schemaId":"schema_880"}],"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":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_879","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_879"}}},{"code":"500","schemaId":"schema_880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_880"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/vibercontroller_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/instagramcontroller_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/messengercontroller_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/telegramcontroller_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/vibercontroller_get_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"RCS","content":null},{"type":"group","label":"RCS Accounts","link":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-accounts","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/rcs-accounts/rcsaccountscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"}],"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":"schema_748"}},"schemaId":"schema_748"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_748","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_748"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/rcs-accounts/rcsaccountscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716"}],"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":"schema_749"}},"schemaId":"schema_749"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_749","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_881","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_881","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_881","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}],"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-1/rcs-questionnaire","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/rcs-questionnaire/questionnairecontroller_getquestions_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-questionnaire/questionnairecontroller_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":"QuestionnaireController_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_716","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_882","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_883","description":"Optional query for sender countries."},{"name":"usQuestionnaireVersion","in":"query","schemaId":"schema_884","description":"Optional query parameter to specify the US questionnaire version for the update."}],"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_716"},{"name":"useCase","in":"path","required":true,"schemaId":"components/schemas/RcsInputSenderUseCasesEnum"}],"query":[{"name":"countries","in":"query","required":false,"schemaId":"schema_883"},{"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/questionnairecontroller_getquestions_v1","openApiOperationId":"QuestionnaireController_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/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsSenderDetailsQuestionnaireBaseDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_885"}},"schemaId":"schema_885"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/response"],"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/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_885","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_885"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-questionnaire/questionnairecontroller_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}],"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/questionnairecontroller_getquestions_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"RCS Senders","link":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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-1/rcs-senders/rcssenderscontroller_listsenders_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","description":"The page size requested."},{"name":"filterConversationApiAppId","in":"query","schemaId":"schema_716","description":"Optional query for sender by Conversation API app id."},{"name":"filterSenderIds","in":"query","schemaId":"schema_716","description":"Optional query for sender by sender ids."},{"name":"filterSenderName","in":"query","schemaId":"schema_716","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_886","description":"Optionally query for sender by states."},{"name":"search","in":"query","schemaId":"schema_716","description":"Search term to filter senders (partial match, case-insensitive)."},{"name":"sortColumn","in":"query","schemaId":"schema_887","description":"Optional query for sender sort column."},{"name":"sortDirection","in":"query","schemaId":"schema_888","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_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"},{"name":"filterConversationApiAppId","in":"query","required":false,"schemaId":"schema_716"},{"name":"filterSenderIds","in":"query","required":false,"schemaId":"schema_716"},{"name":"filterSenderName","in":"query","required":false,"schemaId":"schema_716"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_886"},{"name":"search","in":"query","required":false,"schemaId":"schema_716"},{"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":"schema_889"}},"schemaId":"schema_889"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_889","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_889"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"403","schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/rcs-senders/rcssenderscontroller_createsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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/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/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_716"}],"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/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/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/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":"schema_892"}},"schemaId":"schema_892"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_893"}},"schemaId":"schema_893"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_894"}},"schemaId":"schema_894"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_895"}},"schemaId":"schema_895"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_892","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_892"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"403","schemaId":"schema_893","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_893"}}},{"code":"404","schemaId":"schema_894","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_894"}}},{"code":"409","schemaId":"schema_895","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_895"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_896","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_896","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_896","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_897","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_897","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_897","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_898","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_898","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_898","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_733","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_734","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_716","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_735","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_899","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_899","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_899","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-1/rcs-senders/rcssenderscontroller_getsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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":"schema_900"}},"schemaId":"schema_900"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_900","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_900"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"403","schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/rcs-senders/rcssenderscontroller_updatesender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_884","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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":"schema_901"}},"schemaId":"schema_901"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_902"}},"schemaId":"schema_902"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_901","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"403","schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}}},{"code":"404","schemaId":"schema_902","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_902"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/rcs-senders/rcssenderscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/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_716","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_716","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_716","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_747","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_716"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_747"}],"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":"schema_903"}},"schemaId":"schema_903"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_903","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_903"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"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-1/rcs-senders/senderscontroller_createsendercomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_createsendercomment_v1","openApiOperationId":"SendersController_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":"schema_904"}},"schemaId":"schema_904"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_904","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_904"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/senderscontroller_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-1/rcs-senders/senderscontroller_launchsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders/senderscontroller_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":"SendersController_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":"Questionnaire needs to be completed;"},"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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_launchsender_v1","openApiOperationId":"SendersController_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":"schema_905"}},"schemaId":"schema_905"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_906"}},"schemaId":"schema_906"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_907"}},"schemaId":"schema_907"},{"code":"412","description":"PreconditionFailed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_908"}},"schemaId":"schema_908"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_905","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_905"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"403","schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_890"}}},{"code":"404","schemaId":"schema_906","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_906"}}},{"code":"409","schemaId":"schema_907","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_907"}}},{"code":"412","schemaId":"schema_908","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_908"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/senderscontroller_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-1/rcs-senders/senderscontroller_addtestnumbers_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders/senderscontroller_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":"SendersController_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_716","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_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_addtestnumbers_v1","openApiOperationId":"SendersController_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":"schema_909"}},"schemaId":"schema_909"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_910"}},"schemaId":"schema_910"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_909","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_909"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_910","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_910"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/senderscontroller_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-1/rcs-senders/senderscontroller_gettestnumberstate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders/senderscontroller_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":"SendersController_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_716","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_716","required":true},{"name":"testNumber","in":"path","schemaId":"schema_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_gettestnumberstate_v1","openApiOperationId":"SendersController_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":"schema_911"}},"schemaId":"schema_911"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_912"}},"schemaId":"schema_912"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_911","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_911"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_912","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_912"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/senderscontroller_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-1/rcs-senders/senderscontroller_deletetestnumber_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders/senderscontroller_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":"SendersController_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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"testNumber","in":"path","schemaId":"schema_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_deletetestnumber_v1","openApiOperationId":"SendersController_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":"schema_913"}},"schemaId":"schema_913"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_914"}},"schemaId":"schema_914"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_913","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_913"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_914","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_914"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/senderscontroller_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-1/rcs-senders/senderscontroller_gettestnumbercapabilities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders/senderscontroller_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":"SendersController_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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"testNumber","in":"path","schemaId":"schema_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_gettestnumbercapabilities_v1","openApiOperationId":"SendersController_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":"schema_915"}},"schemaId":"schema_915"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_916"}},"schemaId":"schema_916"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_917"}},"schemaId":"schema_917"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_915","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_915"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"403","schemaId":"schema_916","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_916"}}},{"code":"404","schemaId":"schema_917","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_917"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/senderscontroller_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-1/rcs-senders/senderscontroller_retrytestnumber_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api-1/rcs-senders/senderscontroller_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":"SendersController_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_716","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_716","description":"The unique ID of the sender.","required":true},{"name":"testNumber","in":"path","schemaId":"schema_716","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_716"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_716"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_716"}],"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/senderscontroller_retrytestnumber_v1","openApiOperationId":"SendersController_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":"schema_918"}},"schemaId":"schema_918"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_919"}},"schemaId":"schema_919"},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891"},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"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":"schema_918","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_918"}}},{"code":"401","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"404","schemaId":"schema_919","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_919"}}},{"code":"429","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"500","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/senderscontroller_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}],"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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_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/senderscontroller_retrytestnumber_v1","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/WebhookWebhookTriggers":{"id":"components/schemas/WebhookWebhookTriggers","kind":"json-schema","title":"WebhookWebhookTriggers","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_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","uniqueItems":true,"description":"List of triggers this webhook is triggered by.","items":{"$ref":"#/components/schemas/WebhookWebhookTriggers"}}},"required":["id","target","projectId","triggers"]}},"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","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_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/WebhookWebhookTriggers"}}},"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","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_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/WebhookWebhookTriggers"}}}}},"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/WhatsappCountryCodes":{"id":"components/schemas/WhatsappCountryCodes","kind":"json-schema","title":"WhatsappCountryCodes","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/WhatsappSenderStates":{"id":"components/schemas/WhatsappSenderStates","kind":"json-schema","title":"WhatsappSenderStates","data":{"type":"string","enum":["ACTIVE","IN_PROGRESS","INACTIVE","PENDING_VERIFICATION","SUSPENDED","ERROR"],"description":"The current state of the sender."}},"components/schemas/WhatsappSenderWhatsAppVertical":{"id":"components/schemas/WhatsappSenderWhatsAppVertical","kind":"json-schema","title":"WhatsappSenderWhatsAppVertical","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":{"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVertical"}]},"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":{"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVertical"}]},"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/WhatsappSenderStatuses":{"id":"components/schemas/WhatsappSenderStatuses","kind":"json-schema","title":"WhatsappSenderStatuses","data":{"type":"string","enum":["DRAFT","ERROR","IN_PROGRESS","MULTIPLE_WABA_ERROR","REJECTED"],"description":"Current status of the pending changes."}},"components/schemas/WhatsappSenderErrorCode":{"id":"components/schemas/WhatsappSenderErrorCode","kind":"json-schema","title":"WhatsappSenderErrorCode","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","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":{"description":"Current status of the pending changes.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderStatuses"}]},"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":{"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/WhatsappSenderErrorCode"}]}},"required":["status"]}},"components/schemas/WhatsappWhatsAppSenderFieldUpdateStatus":{"id":"components/schemas/WhatsappWhatsAppSenderFieldUpdateStatus","kind":"json-schema","title":"WhatsappWhatsAppSenderFieldUpdateStatus","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":{"description":"Current approval status of the field.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWhatsAppSenderFieldUpdateStatus"}]},"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":{"username":{"description":"Approval status of the sender username.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetadataFieldDto"}]}}}},"components/schemas/WhatsappSenderBotRegion":{"id":"components/schemas/WhatsappSenderBotRegion","kind":"json-schema","title":"WhatsappSenderBotRegion","data":{"type":"string","enum":["BR","EU","US","UNRECOGNIZED"],"description":"Region sender is provisioned in."}},"components/schemas/WhatsappSenderMetaLocalStorages":{"id":"components/schemas/WhatsappSenderMetaLocalStorages","kind":"json-schema","title":"WhatsappSenderMetaLocalStorages","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":{"description":"App region.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappConversationApiAppRegionsEnum"}]},"channelStatus":{"description":"Status of the channel credentials integration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappConversationAppChannelIntegrationStatusEnum"}]}},"required":["id","projectId","region"]}},"components/schemas/WhatsappQualityRating":{"id":"components/schemas/WhatsappQualityRating","kind":"json-schema","title":"WhatsappQualityRating","data":{"type":"string","enum":["GREEN","RED","YELLOW","UNKNOWN","UNRECOGNIZED"],"description":"Current quality rating of the sender."}},"components/schemas/WhatsappDailyLimit":{"id":"components/schemas/WhatsappDailyLimit","kind":"json-schema","title":"WhatsappDailyLimit","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/WhatsappSenderNumberProviderType":{"id":"components/schemas/WhatsappSenderNumberProviderType","kind":"json-schema","title":"WhatsappSenderNumberProviderType","data":{"type":"string","enum":["CUSTOMER","SINCH","UNRECOGNIZED"],"description":"Provider for phone number."}},"components/schemas/WhatsappBusinessManagers":{"id":"components/schemas/WhatsappBusinessManagers","kind":"json-schema","title":"WhatsappBusinessManagers","data":{"type":"string","enum":["SINCH_AMERICA","SINCH_BR","SINCH_MX","SINCH_SEP","SINCH_UK","UNRECOGNIZED"],"description":"Business manager."}},"components/schemas/WhatsappWabaBanStates":{"id":"components/schemas/WhatsappWabaBanStates","kind":"json-schema","title":"WhatsappWabaBanStates","data":{"type":"string","enum":["DISABLE","REINSTATE","SCHEDULE_FOR_DISABLE","UNRECOGNIZED"],"description":"Please use get account endpoint for this information."}},"components/schemas/WhatsappRegions":{"id":"components/schemas/WhatsappRegions","kind":"json-schema","title":"WhatsappRegions","data":{"type":"string","enum":["br","eu","us"],"description":"Conversation API app regions the sender can be used for."}},"components/schemas/WhatsappComponentTypeHeader":{"id":"components/schemas/WhatsappComponentTypeHeader","kind":"json-schema","title":"WhatsappComponentTypeHeader","data":{"type":"string","enum":["HEADER"]}},"components/schemas/WhatsappLocationHeaderComponentFormat":{"id":"components/schemas/WhatsappLocationHeaderComponentFormat","kind":"json-schema","title":"WhatsappLocationHeaderComponentFormat","data":{"type":"string","enum":["LOCATION"]}},"components/schemas/WhatsappLocationHeaderComponentDto":{"id":"components/schemas/WhatsappLocationHeaderComponentDto","kind":"json-schema","title":"WhatsappLocationHeaderComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentFormat"}]}},"required":["type","format"]}},"components/schemas/WhatsappTextHeaderComponentFormat":{"id":"components/schemas/WhatsappTextHeaderComponentFormat","kind":"json-schema","title":"WhatsappTextHeaderComponentFormat","data":{"type":"string","enum":["TEXT"]}},"components/schemas/WhatsappTextHeaderComponentDto":{"id":"components/schemas/WhatsappTextHeaderComponentDto","kind":"json-schema","title":"WhatsappTextHeaderComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentFormat"}]},"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/WhatsappMediaHeaderComponentFormat":{"id":"components/schemas/WhatsappMediaHeaderComponentFormat","kind":"json-schema","title":"WhatsappMediaHeaderComponentFormat","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentFormat"}]},"example":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderExampleDto"}]}},"required":["type","format"]}},"components/schemas/WhatsappComponentTypeBody":{"id":"components/schemas/WhatsappComponentTypeBody","kind":"json-schema","title":"WhatsappComponentTypeBody","data":{"type":"string","enum":["BODY"]}},"components/schemas/WhatsappBodyComponentDto":{"id":"components/schemas/WhatsappBodyComponentDto","kind":"json-schema","title":"WhatsappBodyComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBody"}]},"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/WhatsappComponentTypeFooter":{"id":"components/schemas/WhatsappComponentTypeFooter","kind":"json-schema","title":"WhatsappComponentTypeFooter","data":{"type":"string","enum":["FOOTER"]}},"components/schemas/WhatsappFooterComponentDto":{"id":"components/schemas/WhatsappFooterComponentDto","kind":"json-schema","title":"WhatsappFooterComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeFooter"}]},"text":{"type":"string","uniqueItems":false},"codeExpirationMinutes":{"type":"number","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypePhoneNumber":{"id":"components/schemas/WhatsappButtonTypePhoneNumber","kind":"json-schema","title":"WhatsappButtonTypePhoneNumber","data":{"type":"string","enum":["PHONE_NUMBER"]}},"components/schemas/WhatsappPhoneNumberButtonDto":{"id":"components/schemas/WhatsappPhoneNumberButtonDto","kind":"json-schema","title":"WhatsappPhoneNumberButtonDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypePhoneNumber"}]},"text":{"type":"string","uniqueItems":false},"phoneNumber":{"type":"string","format":"phone number","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeUrl":{"id":"components/schemas/WhatsappButtonTypeUrl","kind":"json-schema","title":"WhatsappButtonTypeUrl","data":{"type":"string","enum":["URL"]}},"components/schemas/WhatsappUrlButtonDto":{"id":"components/schemas/WhatsappUrlButtonDto","kind":"json-schema","title":"WhatsappUrlButtonDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeUrl"}]},"text":{"type":"string","uniqueItems":false},"url":{"type":"string","format":"url","uniqueItems":false},"example":{"type":"string","format":"url","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeQuickReply":{"id":"components/schemas/WhatsappButtonTypeQuickReply","kind":"json-schema","title":"WhatsappButtonTypeQuickReply","data":{"type":"string","enum":["QUICK_REPLY"]}},"components/schemas/WhatsappQuickReplyButtonDto":{"id":"components/schemas/WhatsappQuickReplyButtonDto","kind":"json-schema","title":"WhatsappQuickReplyButtonDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeQuickReply"}]},"text":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeOtp":{"id":"components/schemas/WhatsappButtonTypeOtp","kind":"json-schema","title":"WhatsappButtonTypeOtp","data":{"type":"string","enum":["OTP"]}},"components/schemas/WhatsappOtpType":{"id":"components/schemas/WhatsappOtpType","kind":"json-schema","title":"WhatsappOtpType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOtp"}]},"otpType":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappOtpType"}]},"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/WhatsappButtonTypeFlow":{"id":"components/schemas/WhatsappButtonTypeFlow","kind":"json-schema","title":"WhatsappButtonTypeFlow","data":{"type":"string","enum":["FLOW"]}},"components/schemas/WhatsappFlowAction":{"id":"components/schemas/WhatsappFlowAction","kind":"json-schema","title":"WhatsappFlowAction","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeFlow"}]},"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":{"description":"Flow action","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappFlowAction"}]},"navigateScreen":{"type":"string","description":"The unique ID of the first screen. Required for Navigate action.","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeRequestContactInfo":{"id":"components/schemas/WhatsappButtonTypeRequestContactInfo","kind":"json-schema","title":"WhatsappButtonTypeRequestContactInfo","data":{"type":"string","enum":["REQUEST_CONTACT_INFO"]}},"components/schemas/WhatsappRequestContactInfoButtonDto":{"id":"components/schemas/WhatsappRequestContactInfoButtonDto","kind":"json-schema","title":"WhatsappRequestContactInfoButtonDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeRequestContactInfo"}]},"text":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappComponentTypeButtons":{"id":"components/schemas/WhatsappComponentTypeButtons","kind":"json-schema","title":"WhatsappComponentTypeButtons","data":{"type":"string","enum":["BUTTONS"]}},"components/schemas/WhatsappButtonsComponentDto":{"id":"components/schemas/WhatsappButtonsComponentDto","kind":"json-schema","title":"WhatsappButtonsComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtons"}]},"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"}]},"uniqueItems":false}},"required":["type","buttons"]}},"components/schemas/WhatsappComponentTypeCarousel":{"id":"components/schemas/WhatsappComponentTypeCarousel","kind":"json-schema","title":"WhatsappComponentTypeCarousel","data":{"type":"string","enum":["CAROUSEL"]}},"components/schemas/WhatsappCardHeaderComponentFormats":{"id":"components/schemas/WhatsappCardHeaderComponentFormats","kind":"json-schema","title":"WhatsappCardHeaderComponentFormats","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"description":"Card header format.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCardHeaderComponentFormats"}]},"example":{"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBody"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtons"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeCarousel"}]},"cards":{"description":"Media cards.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappCardDto"}}},"required":["type","cards"]}},"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"}]},"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}},"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"}]},"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}}}},"components/schemas/WhatsappTemplateStatuses":{"id":"components/schemas/WhatsappTemplateStatuses","kind":"json-schema","title":"WhatsappTemplateStatuses","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":{"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/WhatsappTemplateStatuses"}]},"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/WhatsappTemplateAnalyticsButtonTypes":{"id":"components/schemas/WhatsappTemplateAnalyticsButtonTypes","kind":"json-schema","title":"WhatsappTemplateAnalyticsButtonTypes","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":{"description":"Type of button.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsButtonTypes"}]},"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/WhatsappTemplateStates":{"id":"components/schemas/WhatsappTemplateStates","kind":"json-schema","title":"WhatsappTemplateStates","data":{"type":"string","enum":["APPROVED","DISABLED","PAUSED","REJECTED"]}},"components/schemas/WhatsappTemplateLanguages":{"id":"components/schemas/WhatsappTemplateLanguages","kind":"json-schema","title":"WhatsappTemplateLanguages","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/WhatsappTemplateCategory":{"id":"components/schemas/WhatsappTemplateCategory","kind":"json-schema","title":"WhatsappTemplateCategory","data":{"type":"string","enum":["AUTHENTICATION","MARKETING","UTILITY","UNRECOGNIZED"]}},"components/schemas/WhatsappTemplateRejectionCode":{"id":"components/schemas/WhatsappTemplateRejectionCode","kind":"json-schema","title":"WhatsappTemplateRejectionCode","data":{"type":"string","enum":["ABUSIVE_CONTENT","INCORRECT_CATEGORY","INVALID_FORMAT","NONE","SCAM","UNRECOGNIZED"],"description":"Rejection code if template is in status 'REJECTED'"}},"components/schemas/WhatsappTemplateQualityScore":{"id":"components/schemas/WhatsappTemplateQualityScore","kind":"json-schema","title":"WhatsappTemplateQualityScore","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateStates"}]},"name":{"type":"string","uniqueItems":false},"language":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguages"}]},"category":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateCategory"}]},"rejectionCode":{"description":"Rejection code if template is in status 'REJECTED'","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateRejectionCode"}]},"qualityScore":{"description":"Quality score of the HSM.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateQualityScore"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentFormat"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentFormat"}]},"example":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappPartialMediaHeaderExampleDto"}]}}}},"components/schemas/WhatsappPartialBodyComponentDto":{"id":"components/schemas/WhatsappPartialBodyComponentDto","kind":"json-schema","title":"WhatsappPartialBodyComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBody"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeFooter"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentFormat"}]}}}},"components/schemas/WhatsappPartialCardHeaderComponentDto":{"id":"components/schemas/WhatsappPartialCardHeaderComponentDto","kind":"json-schema","title":"WhatsappPartialCardHeaderComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"description":"Card header format.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCardHeaderComponentFormats"}]},"example":{"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBody"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeUrl"}]},"text":{"type":"string","uniqueItems":false},"url":{"type":"string","format":"url","uniqueItems":false},"example":{"type":"string","format":"url","uniqueItems":false}}}},"components/schemas/WhatsappPartialQuickReplyButtonDto":{"id":"components/schemas/WhatsappPartialQuickReplyButtonDto","kind":"json-schema","title":"WhatsappPartialQuickReplyButtonDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeQuickReply"}]},"text":{"type":"string","uniqueItems":false}}}},"components/schemas/WhatsappPartialPhoneNumberButtonDto":{"id":"components/schemas/WhatsappPartialPhoneNumberButtonDto","kind":"json-schema","title":"WhatsappPartialPhoneNumberButtonDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypePhoneNumber"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtons"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeCarousel"}]},"cards":{"description":"Media cards.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappPartialCardDto"}}}}},"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},"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"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOtp"}]},"otpType":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappOtpType"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeFlow"}]},"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":{"description":"Flow action","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappFlowAction"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtons"}]},"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":{"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/WhatsappTemplateStatuses"}]},"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":{"description":"Type of button.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsButtonTypes"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateStates"}]},"name":{"type":"string","uniqueItems":false},"language":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguages"}]},"category":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateCategory"}]},"rejectionCode":{"description":"Rejection code if template is in status 'REJECTED'","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateRejectionCode"}]},"qualityScore":{"description":"Quality score of the HSM.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateQualityScore"}]},"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/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/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.messageSendTtlSeconds","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.messageSendTtlSeconds","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/WhatsappTemplateStatesEnum":{"id":"components/schemas/WhatsappTemplateStatesEnum","kind":"json-schema","title":"WhatsappTemplateStatesEnum","data":{"type":"string","enum":["APPROVED","DISABLED","PAUSED","REJECTED"]}},"components/schemas/WhatsappTemplateStatusesEnum":{"id":"components/schemas/WhatsappTemplateStatusesEnum","kind":"json-schema","title":"WhatsappTemplateStatusesEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","REJECTED"]}},"components/schemas/WhatsappLocationHeaderComponentInputDto":{"id":"components/schemas/WhatsappLocationHeaderComponentInputDto","kind":"json-schema","title":"WhatsappLocationHeaderComponentInputDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentFormat"}]}},"required":["type","format"]}},"components/schemas/WhatsappTextHeaderComponentInputDto":{"id":"components/schemas/WhatsappTextHeaderComponentInputDto","kind":"json-schema","title":"WhatsappTextHeaderComponentInputDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentFormat"}]},"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},"example":{"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/WhatsappInputMediaHeaderExampleSupportedMimeTypes":{"id":"components/schemas/WhatsappInputMediaHeaderExampleSupportedMimeTypes","kind":"json-schema","title":"WhatsappInputMediaHeaderExampleSupportedMimeTypes","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":{"description":"Optional mime type of file if it can not be determined by the file contents.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputMediaHeaderExampleSupportedMimeTypes"}]}},"required":["url"]}},"components/schemas/WhatsappMediaHeaderComponentInputDto":{"id":"components/schemas/WhatsappMediaHeaderComponentInputDto","kind":"json-schema","title":"WhatsappMediaHeaderComponentInputDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentFormat"}]},"example":{"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBody"}]},"text":{"type":"string","minLength":1,"maxLength":1024,"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeFooter"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypePhoneNumber"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeUrl"}]},"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},"example":{"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":"Example of the full url together with the dynamic value. Required if there is a {{1}} in the URL field, eg"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the 'url' field is 'https://www.my-website.com?name={{1}}', then example can have the following value"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'example' = 'https://www.my-website.com?name=john'"},"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}},"required":["type","text","url"]}},"components/schemas/WhatsappQuickReplyButtonInputDto":{"id":"components/schemas/WhatsappQuickReplyButtonInputDto","kind":"json-schema","title":"WhatsappQuickReplyButtonInputDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeQuickReply"}]},"text":{"type":"string","minLength":1,"maxLength":25,"description":"Not required for draft.","uniqueItems":false}},"required":["type","text"]}},"components/schemas/WhatsappInputOtpType":{"id":"components/schemas/WhatsappInputOtpType","kind":"json-schema","title":"WhatsappInputOtpType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOtp"}]},"otpType":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputOtpType"}]},"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/WhatsappInputFlowAction":{"id":"components/schemas/WhatsappInputFlowAction","kind":"json-schema","title":"WhatsappInputFlowAction","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeFlow"}]},"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":{"description":"Flow action. Not required for draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputFlowAction"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeRequestContactInfo"}]}},"required":["type"]}},"components/schemas/WhatsappButtonsComponentInputDto":{"id":"components/schemas/WhatsappButtonsComponentInputDto","kind":"json-schema","title":"WhatsappButtonsComponentInputDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtons"}]},"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/WhatsappUrlButtonInputDto"}]},"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/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":{"description":"Optional mime type of file if it can not be determined by the file contents.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputMediaHeaderExampleSupportedMimeTypes"}]}},"required":["url"]}},"components/schemas/WhatsappInputCardHeaderComponentDto":{"id":"components/schemas/WhatsappInputCardHeaderComponentDto","kind":"json-schema","title":"WhatsappInputCardHeaderComponentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeader"}]},"format":{"description":"Card header format.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCardHeaderComponentFormats"}]},"example":{"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBody"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtons"}]},"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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeCarousel"}]},"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/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"}]},"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}},"required":["components"]}},"components/schemas/WhatsappActions":{"id":"components/schemas/WhatsappActions","kind":"json-schema","title":"WhatsappActions","data":{"type":"string","enum":["DRAFT","SUBMIT"],"description":"Create as draft or submit. Defaults to submit."}},"components/schemas/WhatsappInputTemplateLanguages":{"id":"components/schemas/WhatsappInputTemplateLanguages","kind":"json-schema","title":"WhatsappInputTemplateLanguages","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/WhatsappTemplateInputCategory":{"id":"components/schemas/WhatsappTemplateInputCategory","kind":"json-schema","title":"WhatsappTemplateInputCategory","data":{"type":"string","enum":["AUTHENTICATION","MARKETING","UTILITY"]}},"components/schemas/WhatsappTemplateInputDto":{"id":"components/schemas/WhatsappTemplateInputDto","kind":"json-schema","title":"WhatsappTemplateInputDto","data":{"type":"object","properties":{"status":{"description":"Create as draft or submit. Defaults to submit.","default":"SUBMIT","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActions"}]},"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]*[a-z0-9]$","maxLength":512,"uniqueItems":false},"language":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputTemplateLanguages"}]},"category":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateInputCategory"}]},"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/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"}]},"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}}}},"components/schemas/WhatsappUpdateTemplateInputDto":{"id":"components/schemas/WhatsappUpdateTemplateInputDto","kind":"json-schema","title":"WhatsappUpdateTemplateInputDto","data":{"type":"object","properties":{"status":{"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActions"}]},"category":{"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/WhatsappTemplateInputCategory"}]},"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/WhatsappCommentType":{"id":"components/schemas/WhatsappCommentType","kind":"json-schema","title":"WhatsappCommentType","data":{"type":"string","enum":["CREATED"]}},"components/schemas/WhatsappCommentDto":{"id":"components/schemas/WhatsappCommentDto","kind":"json-schema","title":"WhatsappCommentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCommentType"}]},"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/WhatsappTemplateNotificationType":{"id":"components/schemas/WhatsappTemplateNotificationType","kind":"json-schema","title":"WhatsappTemplateNotificationType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateNotificationType"}]},"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/WhatsappTemplateCompareBlockReasons":{"id":"components/schemas/WhatsappTemplateCompareBlockReasons","kind":"json-schema","title":"WhatsappTemplateCompareBlockReasons","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":{"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguages"}]},"blockOrder":{"type":"number","description":"Order of block rate","uniqueItems":false},"messageSends":{"type":"number","description":"Message send number","uniqueItems":false},"topBlockReason":{"description":"Block reason","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateCompareBlockReasons"}]}},"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":{"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguages"}]}},"required":["templateName","templateLanguage"]}},"components/schemas/WhatsappInputTemplateCompareTimeframes":{"id":"components/schemas/WhatsappInputTemplateCompareTimeframes","kind":"json-schema","title":"WhatsappInputTemplateCompareTimeframes","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":{"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/WhatsappInputTemplateCompareTimeframes"}]},"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":{"description":"The current state of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderStates"}]},"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":{"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderBotRegion"}]},"metaLocalStorage":{"description":"Region sender store the data in Meta.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetaLocalStorages"}]},"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":{"description":"Current quality rating of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappQualityRating"}]},"dailyLimit":{"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/WhatsappDailyLimit"}]},"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":{"description":"Provider for phone number.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderNumberProviderType"}]},"businessManager":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappBusinessManagers"}]},"wabaBanState":{"description":"Please use get account endpoint for this information.","deprecated":true,"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWabaBanStates"}]},"wabaBanDate":{"type":"string","description":"Please use get account endpoint for this information.","deprecated":true,"uniqueItems":false},"compatibleRegions":{"type":"array","uniqueItems":true,"description":"Conversation API app regions the sender can be used for.","items":{"$ref":"#/components/schemas/WhatsappRegions"}}},"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/WhatsappSenderStatesEnum":{"id":"components/schemas/WhatsappSenderStatesEnum","kind":"json-schema","title":"WhatsappSenderStatesEnum","data":{"type":"string","enum":["ACTIVE","IN_PROGRESS","INACTIVE","PENDING_VERIFICATION","SUSPENDED","ERROR"]}},"components/schemas/WhatsappSenderStatusesEnum":{"id":"components/schemas/WhatsappSenderStatusesEnum","kind":"json-schema","title":"WhatsappSenderStatusesEnum","data":{"type":"string","enum":["DRAFT","ERROR","IN_PROGRESS","MULTIPLE_WABA_ERROR","REJECTED"]}},"components/schemas/WhatsappSenderInputRegion":{"id":"components/schemas/WhatsappSenderInputRegion","kind":"json-schema","title":"WhatsappSenderInputRegion","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/WhatsappSenderInputMetaLocalStorages":{"id":"components/schemas/WhatsappSenderInputMetaLocalStorages","kind":"json-schema","title":"WhatsappSenderInputMetaLocalStorages","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/WhatsappInputBusinessManagersPublicDocumentation":{"id":"components/schemas/WhatsappInputBusinessManagersPublicDocumentation","kind":"json-schema","title":"WhatsappInputBusinessManagersPublicDocumentation","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":{"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/WhatsappSenderInputRegion"}]},"metaLocalStorage":{"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/WhatsappSenderInputMetaLocalStorages"}]},"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":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersPublicDocumentation"}]},"authenticationCode":{"type":"string","minLength":1,"description":"Single-use access code.","uniqueItems":false}},"required":["wabaId","phoneNumberId"]}},"components/schemas/WhatsappSenderInputBotRegion":{"id":"components/schemas/WhatsappSenderInputBotRegion","kind":"json-schema","title":"WhatsappSenderInputBotRegion","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":{"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputBotRegion"}]},"metaLocalStorage":{"description":"Region sender store the data in Meta.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputMetaLocalStorages"}]},"details":{"description":"Sender input details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputSenderPhoneProvisioningDetailsDto"}]}},"required":["details"]}},"components/schemas/WhatsappSenderInputNumberProviderType":{"id":"components/schemas/WhatsappSenderInputNumberProviderType","kind":"json-schema","title":"WhatsappSenderInputNumberProviderType","data":{"type":"string","enum":["CUSTOMER","SINCH"],"description":"If the phone number is provided by Sinch or the customer."}},"components/schemas/WhatsappSenderInputWhatsAppVertical":{"id":"components/schemas/WhatsappSenderInputWhatsAppVertical","kind":"json-schema","title":"WhatsappSenderInputWhatsAppVertical","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"],"description":"Category of the sender displayed in the Business Info within WhatsApp."}},"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":{"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputWhatsAppVertical"}]},"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 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":{"description":"Create as draft or submit. Defaults to submit.","default":"SUBMIT","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActions"}]},"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/WhatsappSenderInputBotRegion"}]},"metaLocalStorage":{"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/WhatsappSenderInputMetaLocalStorages"}]},"phoneNumberProvider":{"description":"If the phone number is provided by Sinch or the customer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputNumberProviderType"}]},"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":{"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputWhatsAppVertical"}]},"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":{"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/WhatsappSenderInputRegion"}]},"metaLocalStorage":{"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/WhatsappSenderInputMetaLocalStorages"}]},"businessManager":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersPublicDocumentation"}]},"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/WhatsappSenderRegistrationMethod":{"id":"components/schemas/WhatsappSenderRegistrationMethod","kind":"json-schema","title":"WhatsappSenderRegistrationMethod","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":{"description":"Registration Method of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderRegistrationMethod"}]},"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/WhatsappSenderInputRegistrationMethod":{"id":"components/schemas/WhatsappSenderInputRegistrationMethod","kind":"json-schema","title":"WhatsappSenderInputRegistrationMethod","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":{"description":"Registration Method of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputRegistrationMethod"}]}},"required":["method"]}},"components/schemas/WhatsappSenderInputVerifyDto":{"id":"components/schemas/WhatsappSenderInputVerifyDto","kind":"json-schema","title":"WhatsappSenderInputVerifyDto","data":{"type":"object","properties":{"code":{"type":"string","format":"otp","example":"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/WhatsappSenderNotificationType":{"id":"components/schemas/WhatsappSenderNotificationType","kind":"json-schema","title":"WhatsappSenderNotificationType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderNotificationType"}]},"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/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":{"type":"string","minLength":1,"maxLength":512,"description":"Description of the sender displayed in the Business Info within WhatsApp. If null the value will be deleted.","nullable":true,"uniqueItems":false},"vertical":{"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputWhatsAppVertical"}]},"email":{"type":"string","format":"email","maxLength":128,"nullable":true,"description":"Contact email displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false},"address":{"type":"string","minLength":1,"maxLength":256,"nullable":true,"description":"Business address displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false},"websiteOne":{"type":"string","format":"url","maxLength":256,"nullable":true,"description":"Business website displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false},"websiteTwo":{"type":"string","format":"url","maxLength":256,"nullable":true,"description":"Second business website displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false},"about":{"type":"string","minLength":1,"maxLength":139,"nullable":true,"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},"photoUrl":{"type":"string","format":"url","maxLength":256,"nullable":true,"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}}}},"components/schemas/WhatsappUpdateSenderInputDto":{"id":"components/schemas/WhatsappUpdateSenderInputDto","kind":"json-schema","title":"WhatsappUpdateSenderInputDto","data":{"type":"object","properties":{"status":{"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActions"}]},"details":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappUpdateSenderInputDetailsDto"}]}}}},"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/WhatsappFailedSolutionErrors":{"id":"components/schemas/WhatsappFailedSolutionErrors","kind":"json-schema","title":"WhatsappFailedSolutionErrors","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":{"readOnly":true,"description":"Error code allows to programmatically handle errors.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappFailedSolutionErrors"}]},"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":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersPublicDocumentation"}]}},"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/WhatsappInputBusinessManagers":{"id":"components/schemas/WhatsappInputBusinessManagers","kind":"json-schema","title":"WhatsappInputBusinessManagers","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":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagers"}]}},"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":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagers"}]}}}},"components/schemas/WhatsappInputAccountWhatsAppVerticals":{"id":"components/schemas/WhatsappInputAccountWhatsAppVerticals","kind":"json-schema","title":"WhatsappInputAccountWhatsAppVerticals","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","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":{"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputAccountWhatsAppVerticals"}]},"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/WhatsappSenderInputRegion"}]},"metaLocalStorage":{"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/WhatsappSenderInputMetaLocalStorages"}]}},"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":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagers"}]},"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":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagers"}]},"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/WhatsappAccountState":{"id":"components/schemas/WhatsappAccountState","kind":"json-schema","title":"WhatsappAccountState","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":{"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVertical"}]},"region":{"description":"Region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderBotRegion"}]},"metaLocalStorage":{"description":"Local storage region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetaLocalStorages"}]}},"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":{"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVertical"}]},"region":{"description":"Region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderBotRegion"}]},"metaLocalStorage":{"description":"Local storage region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetaLocalStorages"}]}},"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/WhatsappAccountChangeState":{"id":"components/schemas/WhatsappAccountChangeState","kind":"json-schema","title":"WhatsappAccountChangeState","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":{"description":"Current status of the pending changes.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountChangeState"}]},"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":{"description":"The current state of your account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountState"}]},"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":{"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappBusinessManagers"}]},"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":{"description":"Ban state when account has been banned.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWabaBanStates"}]},"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},"compatibleRegions":{"type":"array","uniqueItems":true,"description":"Conversation API app regions the sender can be used for.","items":{"$ref":"#/components/schemas/WhatsappRegions"}},"primaryBusinessLocation":{"description":"Two-letter country code in ISO 3166 standard, specifying the country where business is based","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCountryCodes"}]},"partnerInitiatedRequestId":{"type":"string","deprecated":true,"description":"Deprecated. This field is retained for backward compatibility and is always returned as undefined.","uniqueItems":false},"businessDailyLimit":{"description":"Current daily message limit of the account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappDailyLimit"}]},"currency":{"type":"string","description":"The currency code for the account.","uniqueItems":false}},"required":["isEmbeddedSignup","businessManager","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":{"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputAccountWhatsAppVerticals"}]},"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/WhatsappSenderInputRegion"}]},"metaLocalStorage":{"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/WhatsappSenderInputMetaLocalStorages"}]}}}},"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/WhatsappAccountNotificationType":{"id":"components/schemas/WhatsappAccountNotificationType","kind":"json-schema","title":"WhatsappAccountNotificationType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountNotificationType"}]},"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/WhatsappWhatsAppFlowStatuses":{"id":"components/schemas/WhatsappWhatsAppFlowStatuses","kind":"json-schema","title":"WhatsappWhatsAppFlowStatuses","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":{"description":"Flow status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWhatsAppFlowStatuses"}]}},"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/BundlesWebhooksInputWebhookTrigger":{"id":"components/schemas/BundlesWebhooksInputWebhookTrigger","kind":"json-schema","title":"BundlesWebhooksInputWebhookTrigger","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/BundlesInputWebhookTargetTypes":{"id":"components/schemas/BundlesInputWebhookTargetTypes","kind":"json-schema","title":"BundlesInputWebhookTargetTypes","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","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/BundlesWebhooksInputWebhookTrigger"}},"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":{"description":"Conversation API webhook target type.","default":"HTTP","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputWebhookTargetTypes"}]}},"required":["target","triggers"]}},"components/schemas/BundlesInputConversationAppConversationRetentionPolicyTypes":{"id":"components/schemas/BundlesInputConversationAppConversationRetentionPolicyTypes","kind":"json-schema","title":"BundlesInputConversationAppConversationRetentionPolicyTypes","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":{"description":"\nConversation API conversation retention policy type.\n    ","default":"MESSAGE_EXPIRE_POLICY","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppConversationRetentionPolicyTypes"}]},"ttl":{"type":"number","minimum":1,"maximum":3650,"description":"\nConversation API conversation retention time in days.\n    ","default":180,"uniqueItems":false}}}},"components/schemas/BundlesInputConversationAppDispatchRetentionPolicyTypes":{"id":"components/schemas/BundlesInputConversationAppDispatchRetentionPolicyTypes","kind":"json-schema","title":"BundlesInputConversationAppDispatchRetentionPolicyTypes","data":{"type":"string","enum":["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":{"description":"\nConversation API dispatch retention policy type.\n    ","default":"MESSAGE_EXPIRE_POLICY","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppDispatchRetentionPolicyTypes"}]},"ttl":{"type":"number","minimum":0,"maximum":7,"description":"\nConversation API dispatch retention time in days.\n    ","default":7,"uniqueItems":false}}}},"components/schemas/BundlesInputConversationAppProcessingModes":{"id":"components/schemas/BundlesInputConversationAppProcessingModes","kind":"json-schema","title":"BundlesInputConversationAppProcessingModes","data":{"type":"string","enum":["CONVERSATION","DISPATCH"],"description":"\nConversation API processing mode. May be changed later by using Conversation App API.\n    "}},"components/schemas/BundlesInputConversationAppConsentManagerSettingsModes":{"id":"components/schemas/BundlesInputConversationAppConsentManagerSettingsModes","kind":"json-schema","title":"BundlesInputConversationAppConsentManagerSettingsModes","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":{"description":"\nConversation API consent manager settings mode.\n    ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppConsentManagerSettingsModes"}]}},"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":{"description":"\nConversation API processing mode. May be changed later by using Conversation App API.\n    ","default":"DISPATCH","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppProcessingModes"}]},"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/BundlesWebhookTriggers":{"id":"components/schemas/BundlesWebhookTriggers","kind":"json-schema","title":"BundlesWebhookTriggers","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_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_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","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_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/BundlesWebhookTriggers"}}},"required":["target","secret","triggers"]}},"components/schemas/BundlesBundlesInputRegion":{"id":"components/schemas/BundlesBundlesInputRegion","kind":"json-schema","title":"BundlesBundlesInputRegion","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","example":"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":{"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/BundlesBundlesInputRegion"}]},"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/BundlesBundleServicesState":{"id":"components/schemas/BundlesBundleServicesState","kind":"json-schema","title":"BundlesBundleServicesState","data":{"type":"string","enum":["DONE","FAILED","IN_PROGRESS"],"description":"Current state."}},"components/schemas/BundlesHttpStatusCode":{"id":"components/schemas/BundlesHttpStatusCode","kind":"json-schema","title":"BundlesHttpStatusCode","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesHttpStatusCode"}]},"errorMessage":{"type":"string","uniqueItems":false},"date":{"type":"string","uniqueItems":false}},"required":["webhookId","httpStatusCode","date"]}},"components/schemas/BundlesBundlesRegion":{"id":"components/schemas/BundlesBundlesRegion","kind":"json-schema","title":"BundlesBundlesRegion","data":{"type":"string","enum":["BR","EU","US"],"description":"Region resources were create in."}},"components/schemas/BundlesSubprojectStatus":{"id":"components/schemas/BundlesSubprojectStatus","kind":"json-schema","title":"BundlesSubprojectStatus","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":{"description":"Status of subproject.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesSubprojectStatus"}]}},"required":["id","name","parentProjectId","status"]}},"components/schemas/BundlesProvisioningStates":{"id":"components/schemas/BundlesProvisioningStates","kind":"json-schema","title":"BundlesProvisioningStates","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/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":{"description":"Status of SMS App.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesProvisioningStates"}]},"regions":{"type":"array","description":"List of regions of the app.","uniqueItems":false,"items":{"type":"string","enum":["AU","BR","CA","EU","US","UNRECOGNIZED"]}},"test":{"type":"boolean","description":"True if the app is a test app.","uniqueItems":false}},"required":["id","smsServiceId","name","status","regions","test"]}},"components/schemas/BundlesWebhooksWebhookTrigger":{"id":"components/schemas/BundlesWebhooksWebhookTrigger","kind":"json-schema","title":"BundlesWebhooksWebhookTrigger","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","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/BundlesWebhooksWebhookTrigger"}},"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/BundlesConversationAppProcessingModes":{"id":"components/schemas/BundlesConversationAppProcessingModes","kind":"json-schema","title":"BundlesConversationAppProcessingModes","data":{"type":"string","enum":["CONVERSATION","DISPATCH","UNRECOGNIZED","UNSPECIFIED"],"description":"Conversation API processing mode."}},"components/schemas/BundlesConversationAppRetentionPolicyTypes":{"id":"components/schemas/BundlesConversationAppRetentionPolicyTypes","kind":"json-schema","title":"BundlesConversationAppRetentionPolicyTypes","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":{"description":"\nConversation API retention policy type.\n    ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppRetentionPolicyTypes"}]},"ttl":{"type":"number","description":"\nConversation API retention time in days.\n    ","uniqueItems":false}},"required":["retentionPolicyType"]}},"components/schemas/BundlesConversationAppConsentManagerSettingsModes":{"id":"components/schemas/BundlesConversationAppConsentManagerSettingsModes","kind":"json-schema","title":"BundlesConversationAppConsentManagerSettingsModes","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":{"description":"\nConversation API consent manager settings mode.\n    ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppConsentManagerSettingsModes"}]}},"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":{"description":"Conversation API processing mode.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppProcessingModes"}]},"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":{"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","uniqueItems":true,"description":"List of triggers this webhook is triggered by.","items":{"$ref":"#/components/schemas/BundlesWebhookTriggers"}}},"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":{"description":"Current state.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesBundleServicesState"}]},"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":{"description":"Region resources were create in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesBundlesRegion"}]},"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/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/BundlesBundleServicesStateEnum":{"id":"components/schemas/BundlesBundleServicesStateEnum","kind":"json-schema","title":"BundlesBundleServicesStateEnum","data":{"type":"string","enum":["DONE","FAILED","IN_PROGRESS"]}},"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/KakaotalkTemplateSubcategoryNames":{"id":"components/schemas/KakaotalkTemplateSubcategoryNames","kind":"json-schema","title":"KakaotalkTemplateSubcategoryNames","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/KakaotalkTemplateSubcategoryEnglishNames":{"id":"components/schemas/KakaotalkTemplateSubcategoryEnglishNames","kind":"json-schema","title":"KakaotalkTemplateSubcategoryEnglishNames","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":{"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/KakaotalkTemplateSubcategoryNames"}]},"nameEnglish":{"description":"English subcategory name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateSubcategoryEnglishNames"}]},"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/KakaotalkTemplateCategoryNames":{"id":"components/schemas/KakaotalkTemplateCategoryNames","kind":"json-schema","title":"KakaotalkTemplateCategoryNames","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/KakaotalkTemplateCategoryEnglishNames":{"id":"components/schemas/KakaotalkTemplateCategoryEnglishNames","kind":"json-schema","title":"KakaotalkTemplateCategoryEnglishNames","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":{"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/KakaotalkTemplateCategoryNames"}]},"nameEnglish":{"description":"English category name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateCategoryEnglishNames"}]},"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/KakaotalkTemplateStates":{"id":"components/schemas/KakaotalkTemplateStates","kind":"json-schema","title":"KakaotalkTemplateStates","data":{"type":"string","enum":["APPROVED","REJECTED"],"description":"The current state of the template."}},"components/schemas/KakaotalkKakaoTalkButtonType":{"id":"components/schemas/KakaotalkKakaoTalkButtonType","kind":"json-schema","title":"KakaotalkKakaoTalkButtonType","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":{"description":"Button type","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkButtonType"}]},"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/KakaotalkTemplateLanguages":{"id":"components/schemas/KakaotalkTemplateLanguages","kind":"json-schema","title":"KakaotalkTemplateLanguages","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/KakaotalkKakaoTalkTemplateMessageType":{"id":"components/schemas/KakaotalkKakaoTalkTemplateMessageType","kind":"json-schema","title":"KakaotalkKakaoTalkTemplateMessageType","data":{"type":"string","enum":["AD_INCLUDED","BASIC","EXTRA_INFORMATION","MIXED","TEMPLATE_MESSAGE_TYPE_UNSPECIFIED","UNRECOGNIZED"],"description":"Types of template message"}},"components/schemas/KakaotalkKakaoTalkTemplateEmphasizeType":{"id":"components/schemas/KakaotalkKakaoTalkTemplateEmphasizeType","kind":"json-schema","title":"KakaotalkKakaoTalkTemplateEmphasizeType","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":{"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateLanguages"}]},"messageType":{"description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateMessageType"}]},"emphasizeType":{"description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateEmphasizeType"}]},"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":{"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateLanguages"}]},"messageType":{"description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateMessageType"}]},"emphasizeType":{"description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateEmphasizeType"}]},"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/KakaotalkTemplateStatuses":{"id":"components/schemas/KakaotalkTemplateStatuses","kind":"json-schema","title":"KakaotalkTemplateStatuses","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":{"description":"Current status of the pending changes","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateStatuses"}]},"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":{"description":"The current state of the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateStates"}]},"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/KakaotalkTemplateStatesEnum":{"id":"components/schemas/KakaotalkTemplateStatesEnum","kind":"json-schema","title":"KakaotalkTemplateStatesEnum","data":{"type":"string","enum":["APPROVED","REJECTED"]}},"components/schemas/KakaotalkTemplateStatusesEnum":{"id":"components/schemas/KakaotalkTemplateStatusesEnum","kind":"json-schema","title":"KakaotalkTemplateStatusesEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","REJECTED"]}},"components/schemas/KakaotalkActions":{"id":"components/schemas/KakaotalkActions","kind":"json-schema","title":"KakaotalkActions","data":{"type":"string","enum":["DRAFT","SUBMIT"],"description":"Create as draft or submit. Defaults to submit."}},"components/schemas/KakaotalkInputKakaoTalkButtonType":{"id":"components/schemas/KakaotalkInputKakaoTalkButtonType","kind":"json-schema","title":"KakaotalkInputKakaoTalkButtonType","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":{"description":"Button type","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkButtonType"}]},"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/KakaotalkInputTemplateLanguages":{"id":"components/schemas/KakaotalkInputTemplateLanguages","kind":"json-schema","title":"KakaotalkInputTemplateLanguages","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/KakaotalkInputKakaoTalkTemplateMessageType":{"id":"components/schemas/KakaotalkInputKakaoTalkTemplateMessageType","kind":"json-schema","title":"KakaotalkInputKakaoTalkTemplateMessageType","data":{"type":"string","enum":["AD_INCLUDED","BASIC","EXTRA_INFORMATION","MIXED"],"description":"Types of template message"}},"components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeType":{"id":"components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeType","kind":"json-schema","title":"KakaotalkInputKakaoTalkTemplateEmphasizeType","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":{"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputTemplateLanguages"}]},"content":{"type":"string","minLength":1,"maxLength":1000,"description":"Template body Not required for draft.","uniqueItems":false},"messageType":{"default":"BASIC","description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateMessageType"}]},"emphasizeType":{"default":"EMPHASIZE_TYPE_NONE","description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeType"}]},"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":{"default":"SUBMIT","description":"Create as draft or submit. Defaults to submit.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActions"}]},"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":{"description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateMessageType"}]},"emphasizeType":{"description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeType"}]},"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":{"type":"string","minLength":1,"maxLength":500,"nullable":true,"description":"Additional template information","uniqueItems":false},"title":{"type":"string","minLength":1,"maxLength":50,"nullable":true,"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,"nullable":true,"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,"nullable":true,"description":"Image name (name of uploaded file)","uniqueItems":false},"imageUrl":{"type":"string","format":"url","nullable":true,"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,"nullable":true,"description":"List of buttons Field 'type' must have unique values across items.","type":"array","items":{"$ref":"#/components/schemas/KakaotalkInputButtonDto"}}}}},"components/schemas/KakaotalkInputUpdateTemplateDto":{"id":"components/schemas/KakaotalkInputUpdateTemplateDto","kind":"json-schema","title":"KakaotalkInputUpdateTemplateDto","data":{"type":"object","properties":{"status":{"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActions"}]},"details":{"description":"Template details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputUpdateTemplateDetailsDto"}]}}}},"components/schemas/KakaotalkCommentType":{"id":"components/schemas/KakaotalkCommentType","kind":"json-schema","title":"KakaotalkCommentType","data":{"type":"string","enum":["CREATED"]}},"components/schemas/KakaotalkCommentDto":{"id":"components/schemas/KakaotalkCommentDto","kind":"json-schema","title":"KakaotalkCommentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkCommentType"}]},"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/KakaotalkTemplateNotificationType":{"id":"components/schemas/KakaotalkTemplateNotificationType","kind":"json-schema","title":"KakaotalkTemplateNotificationType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateNotificationType"}]},"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/KakaotalkSenderStates":{"id":"components/schemas/KakaotalkSenderStates","kind":"json-schema","title":"KakaotalkSenderStates","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/KakaotalkSenderStatuses":{"id":"components/schemas/KakaotalkSenderStatuses","kind":"json-schema","title":"KakaotalkSenderStatuses","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":{"description":"Current status of the pending changes.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderStatuses"}]},"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":{"description":"The current state of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderStates"}]},"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":{"description":"Create as draft or submit. Defaults to submit.","default":"SUBMIT","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActions"}]},"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","example":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/KakaotalkSenderStatesEnum":{"id":"components/schemas/KakaotalkSenderStatesEnum","kind":"json-schema","title":"KakaotalkSenderStatesEnum","data":{"type":"string","enum":["ACTIVE","BLOCKED","INACTIVE","SUSPENDED","VERIFYING"]}},"components/schemas/KakaotalkSenderStatusesEnum":{"id":"components/schemas/KakaotalkSenderStatusesEnum","kind":"json-schema","title":"KakaotalkSenderStatusesEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","REJECTED"]}},"components/schemas/KakaotalkSenderNotificationType":{"id":"components/schemas/KakaotalkSenderNotificationType","kind":"json-schema","title":"KakaotalkSenderNotificationType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderNotificationType"}]},"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":{"type":"string","description":"Sender logo","format":"url","nullable":true,"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/KakaotalkInputUpdateSenderDto":{"id":"components/schemas/KakaotalkInputUpdateSenderDto","kind":"json-schema","title":"KakaotalkInputUpdateSenderDto","data":{"type":"object","properties":{"status":{"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActions"}]},"details":{"description":"Sender details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputUpdateSenderDetailsDto"}]}}}},"components/schemas/ConversationChannelStatus":{"id":"components/schemas/ConversationChannelStatus","kind":"json-schema","title":"ConversationChannelStatus","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":{"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatus"}]},"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/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":{"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatus"}]},"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":{"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatus"}]},"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":{"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatus"}]},"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/RcsAccountNotificationType":{"id":"components/schemas/RcsAccountNotificationType","kind":"json-schema","title":"RcsAccountNotificationType","data":{"type":"string","enum":["COMMENT_ADDED","CREATED"]}},"components/schemas/RcsAccountNotificationDto":{"id":"components/schemas/RcsAccountNotificationDto","kind":"json-schema","title":"RcsAccountNotificationDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsAccountNotificationType"}]},"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/RcsCommentType":{"id":"components/schemas/RcsCommentType","kind":"json-schema","title":"RcsCommentType","data":{"type":"string","enum":["CREATED"]}},"components/schemas/RcsCommentDto":{"id":"components/schemas/RcsCommentDto","kind":"json-schema","title":"RcsCommentDto","data":{"type":"object","properties":{"type":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsCommentType"}]},"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/RcsOperatorStatus":{"id":"components/schemas/RcsOperatorStatus","kind":"json-schema","title":"RcsOperatorStatus","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":{"description":"Operator status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsOperatorStatus"}]},"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/RcsCountryCodes":{"id":"components/schemas/RcsCountryCodes","kind":"json-schema","title":"RcsCountryCodes","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":{"description":"Two-letter country code in ISO 3166 standard.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsCountryCodes"}]},"status":{"description":"Country status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsOperatorStatus"}]},"operators":{"type":"array","items":{"$ref":"#/components/schemas/RcsOperatorDto"},"description":"Mobile network operators.","uniqueItems":false}},"required":["country","status","operators"]}},"components/schemas/RcsTestNumberStates":{"id":"components/schemas/RcsTestNumberStates","kind":"json-schema","title":"RcsTestNumberStates","data":{"type":"string","enum":["DECLINED","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":{"description":"Test phone state.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsTestNumberStates"}]},"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":{"description":"App region.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsConversationApiAppRegionsEnum"}]},"channelStatus":{"description":"Status of the channel credentials integration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsConversationAppChannelIntegrationStatusEnum"}]}},"required":["id","projectId","region"]}},"components/schemas/RcsSenderStates":{"id":"components/schemas/RcsSenderStates","kind":"json-schema","title":"RcsSenderStates","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/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.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["name","email","title","website","phone"]}},"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.","uniqueItems":false}}}},"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/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","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"}]},"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"}]},"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":["companyLegalName","companyPhoneNumber","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/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto":{"id":"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto","kind":"json-schema","title":"RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto","data":{"type":"object","properties":{"ownershipType":{"type":"string","enum":["PRIVATE","PUBLIC"],"description":"Ownership type of the company. 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},"companyPhoneNumber":{"type":"string","description":"The registered phone number 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":{"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.","uniqueItems":false},"legalForm":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"],"description":"Legal form of the company.","uniqueItems":false},"taxIdCountry":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"Country of the company's tax registration.","uniqueItems":false},"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":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"Country. Not required for create, but required for launch.","uniqueItems":false},"addressState":{"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.","uniqueItems":false},"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":{"readOnly":true,"description":"Launch questions specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"}]},"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/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","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/RcsCountryCodes"}},"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/RcsSenderRegions":{"id":"components/schemas/RcsSenderRegions","kind":"json-schema","title":"RcsSenderRegions","data":{"type":"string","enum":["BR","EU","US"],"description":"Region sender is provisioned in."}},"components/schemas/RcsSenderBillingCategories":{"id":"components/schemas/RcsSenderBillingCategories","kind":"json-schema","title":"RcsSenderBillingCategories","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/RcsSenderUseCases":{"id":"components/schemas/RcsSenderUseCases","kind":"json-schema","title":"RcsSenderUseCases","data":{"type":"string","enum":["MULTIUSE","OTP","PROMOTIONAL","TRANSACTIONAL"],"description":"Use case."}},"components/schemas/RcsSenderHostingRegions":{"id":"components/schemas/RcsSenderHostingRegions","kind":"json-schema","title":"RcsSenderHostingRegions","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/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":{"type":"string","enum":["ARCHIVED","COMPLETED","INCOMPLETE","NEW","PENDING","PENDING_REVIEW","REJECTED","UNRECOGNIZED","UNSPECIFIED"],"description":"Current status of the brand registration process.","uniqueItems":false}},"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":{"type":"string","enum":["ARCHIVED","COMPLETED","DRAFT","UNRECOGNIZED","UNSPECIFIED"],"description":"Current status of the brand registration.","uniqueItems":false},"registration":{"description":"Details of the channel-specific registration process.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandRegistrationProcessDto"}]}},"required":["id","status","registration"]}},"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":{"description":"The current state of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderStates"}]},"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":{"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderRegions"}]},"billingCategory":{"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/RcsSenderBillingCategories"}]},"useCase":{"description":"Use case.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderUseCases"}]},"hostingRegion":{"description":"Internal Google hosting region","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderHostingRegions"}]},"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"}]}},"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/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"]}},"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/RcsInputSenderRegions":{"id":"components/schemas/RcsInputSenderRegions","kind":"json-schema","title":"RcsInputSenderRegions","data":{"type":"string","enum":["BR","EU","US"],"description":"Region sender is provisioned in."}},"components/schemas/RcsInputSenderBillingCategories":{"id":"components/schemas/RcsInputSenderBillingCategories","kind":"json-schema","title":"RcsInputSenderBillingCategories","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/RcsInputSenderUseCases":{"id":"components/schemas/RcsInputSenderUseCases","kind":"json-schema","title":"RcsInputSenderUseCases","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}$","patternErrorMessage":"number must be a phone number without country code and without separators or number must be a valid e.164 phone number","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/RcsInputCountryCodes":{"id":"components/schemas/RcsInputCountryCodes","kind":"json-schema","title":"RcsInputCountryCodes","data":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","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/RcsSenderDetailsQuestionnaireVerificationAnswersInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationAnswersInputDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Name of verification contact.","uniqueItems":false},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of verification contact.","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.","uniqueItems":false},"phone":{"type":"string","minLength":1,"maxLength":11,"description":"Phone number of verification contact.","uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationInputDto","data":{"type":"object","properties":{"answers":{"description":"Verification answers.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersInputDto"}]}},"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/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"ownershipType":{"type":"string","enum":["PRIVATE","PUBLIC"],"description":"Ownership type of the company. 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.","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},"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":{"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.","uniqueItems":false},"legalForm":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","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 LIMITED_LIABILITY_COMPANY, PARTNERSHIP, and S_CORPORATION. Not required for create, but required for launch."},"children":[]}]}]}],"uniqueItems":false},"taxIdCountry":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"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},"taxId":{"type":"string","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},"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":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"Country. Not required for create, but required for launch.","uniqueItems":false},"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},"addressState":{"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":[{"$$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},"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":["ownershipType","companyLegalName","companyPhoneNumber","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","addressState","stockExchange","stockSymbol"]}},"components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"ownershipType":{"type":"string","enum":["PRIVATE","PUBLIC"],"description":"Ownership type of the company. 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.","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},"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":{"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.","uniqueItems":false},"legalForm":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","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 LIMITED_LIABILITY_COMPANY, PARTNERSHIP, and S_CORPORATION. Not required for create, but required for launch."},"children":[]}]}]}],"uniqueItems":false},"taxIdCountry":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"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},"taxId":{"type":"string","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},"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":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"Country. Not required for create, but required for launch.","uniqueItems":false},"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},"addressState":{"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":[{"$$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}},"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":["ownershipType","companyLegalName","companyPhoneNumber","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","addressState"]}},"components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"ownershipType":{"type":"string","enum":["PRIVATE","PUBLIC"],"description":"Ownership type of the company. 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.","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},"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":{"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.","uniqueItems":false},"legalForm":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","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 LIMITED_LIABILITY_COMPANY, PARTNERSHIP, and S_CORPORATION. Not required for create, but required for launch."},"children":[]}]}]}],"uniqueItems":false},"taxIdCountry":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"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},"taxId":{"type":"string","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},"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":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"Country. Not required for create, but required for launch.","uniqueItems":false},"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},"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":["ownershipType","companyLegalName","companyPhoneNumber","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","stockExchange","stockSymbol"]}},"components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"ownershipType":{"type":"string","enum":["PRIVATE","PUBLIC"],"description":"Ownership type of the company. 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.","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},"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":{"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.","uniqueItems":false},"legalForm":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","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 LIMITED_LIABILITY_COMPANY, PARTNERSHIP, and S_CORPORATION. Not required for create, but required for launch."},"children":[]}]}]}],"uniqueItems":false},"taxIdCountry":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"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},"taxId":{"type":"string","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},"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":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"Country. Not required for create, but required for launch.","uniqueItems":false},"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}},"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":["ownershipType","companyLegalName","companyPhoneNumber","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage"]}},"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}$","patternErrorMessage":"EIN must follow format: XX-XXXXXXX","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","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/RcsInputCountryCodes"}},"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":{"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputSenderRegions"}]},"billingCategory":{"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/RcsInputSenderBillingCategories"}]},"useCase":{"description":"Use case.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputSenderUseCases"}]},"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.","nullable":true,"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/RcsEmailInputDto"}},"phones":{"minItems":1,"maxItems":3,"description":"Contact phone numbers. If null the value will be deleted. Field 'number' must have unique values across items.","nullable":true,"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/RcsPhoneInputDto"}},"websites":{"minItems":1,"maxItems":3,"description":"Contact websites. If null the value will be deleted. Field 'url' must have unique values across items.","nullable":true,"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/RcsWebsiteInputDto"}},"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":{"type":"string","minLength":1,"nullable":true,"description":"Ignore given string on launch, e.g. custom delimiter. If null the value will be deleted.","uniqueItems":false}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto","data":{"type":"object","properties":{"optInDescription":{"type":"string","minLength":1,"nullable":true,"description":"How you obtain opt-in to message users. If null the value will be deleted.","uniqueItems":false},"optInDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"triggerDescription":{"type":"string","minLength":1,"nullable":true,"description":"Actions that triggers messages to users. If null the value will be deleted.","uniqueItems":false},"triggerDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"interactionsDescription":{"type":"string","minLength":1,"nullable":true,"description":"Interactions with users. If null the value will be deleted.","uniqueItems":false},"interactionsDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"optOutDescription":{"type":"string","minLength":1,"nullable":true,"description":"The message the sender sends when a user opts out. If null the value will be deleted.","uniqueItems":false},"optOutDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"videoUris":{"minItems":1,"nullable":true,"description":"Publicly available URIs for videos of the sender, for review purposes only. If null the value will be deleted.","uniqueItems":false,"type":"array","items":{"type":"string","format":"url"}},"screenshotUris":{"minItems":1,"nullable":true,"description":"Publicly available URIs for screenshots of the sender, for review purposes only. If null the value will be deleted.","uniqueItems":false,"type":"array","items":{"type":"string","format":"url"}}}}},"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/RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"nullable":true,"description":"Name of verification contact. If null the value will be deleted.","uniqueItems":false},"email":{"type":"string","format":"email","maxLength":100,"nullable":true,"description":"Email of verification contact. If null the value will be deleted.","uniqueItems":false},"title":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"description":"Title of verification contact. If null the value will be deleted.","uniqueItems":false},"website":{"type":"string","format":"url","nullable":true,"description":"Website of verification contact. If null the value will be deleted.","uniqueItems":false},"phone":{"type":"string","minLength":1,"maxLength":11,"nullable":true,"description":"Phone number of verification contact. If null the value will be deleted.","uniqueItems":false}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireVerificationInputDto","data":{"type":"object","properties":{"answers":{"description":"Verification answers.","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":{"type":"string","minLength":1,"nullable":true,"description":"Sector or industry of business. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false},"companyLegalName":{"type":"string","minLength":1,"nullable":true,"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},"companyRegistrationNumber":{"type":"string","minLength":1,"nullable":true,"description":"The company registration number.","uniqueItems":false},"fullCompanyAddress":{"type":"string","minLength":1,"nullable":true,"description":"Full company address. If null the value will be deleted.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"messagesVolume":{"type":"string","minLength":1,"nullable":true,"description":"Messages volume. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false},"messagesFrequency":{"type":"string","minLength":1,"nullable":true,"description":"Messages frequency. If null the value will be deleted.","uniqueItems":false},"campaignLength":{"type":"string","minLength":1,"nullable":true,"description":"Length of campaign. If null the value will be deleted.","deprecated":true,"uniqueItems":false}}}},"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":{"type":"string","minLength":1,"nullable":true,"description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"siren":{"type":"string","pattern":"^\\d+$","minLength":9,"maxLength":9,"nullable":true,"description":"Company directory identification system number.","uniqueItems":false}}}},"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":{"type":"string","enum":["PRIVATE","PUBLIC"],"description":"Ownership type of the company. Not required for create, but required for launch.","nullable":true,"uniqueItems":false},"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","minLength":1,"maxLength":100,"nullable":true,"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,"nullable":true,"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,"nullable":true,"uniqueItems":false},"brandIndustry":{"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.","nullable":true,"uniqueItems":false},"legalForm":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","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 LIMITED_LIABILITY_COMPANY, PARTNERSHIP, and S_CORPORATION. Not required for create, but required for launch."},"children":[]}]}]}],"nullable":true,"uniqueItems":false},"taxIdCountry":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"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.","nullable":true,"uniqueItems":false},"taxId":{"type":"string","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,"nullable":true,"uniqueItems":false},"addressLine":{"type":"string","description":"Street address line. Not required for create, but required for launch.","minLength":1,"maxLength":100,"nullable":true,"uniqueItems":false},"addressCity":{"type":"string","description":"City. Not required for create, but required for launch.","minLength":1,"maxLength":100,"nullable":true,"uniqueItems":false},"addressCountry":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"Country. Not required for create, but required for launch.","nullable":true,"uniqueItems":false},"addressState":{"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":[{"$$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":[]}]}]}],"nullable":true,"uniqueItems":false},"addressPostalCode":{"type":"string","description":"Postal code. Not required for create, but required for launch.","minLength":1,"maxLength":10,"nullable":true,"uniqueItems":false},"websiteUrl":{"type":"string","description":"Primary website URL. Not required for create, but required for launch.","format":"url","maxLength":100,"nullable":true,"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,"nullable":true,"uniqueItems":false},"contactSurname":{"type":"string","description":"Surname of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"nullable":true,"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,"nullable":true,"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,"nullable":true,"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,"nullable":true,"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.","nullable":true,"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.","nullable":true,"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.","nullable":true,"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.","nullable":true,"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.","nullable":true,"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,"nullable":true,"uniqueItems":false},"helpMessage":{"type":"string","description":"Help message of the campaign. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"nullable":true,"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,"nullable":true,"uniqueItems":false}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","minLength":0,"nullable":true,"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}$","patternErrorMessage":"EIN must follow format: XX-XXXXXXX","nullable":true,"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,"nullable":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false},"fullCompanyAddress":{"type":"string","minLength":0,"nullable":true,"description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"smsCampaign":{"type":"string","minLength":0,"nullable":true,"description":"US SMS campaign used as fallback.","uniqueItems":false},"messagesVolume":{"type":"string","minLength":0,"nullable":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false}},"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":{"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.","nullable":true,"type":"array","items":{"type":"string","format":"e.164 phone number"}},"countries":{"type":"array","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.","nullable":true,"items":{"$ref":"#/components/schemas/RcsInputCountryCodes"}},"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/RcsSenderNotificationType":{"id":"components/schemas/RcsSenderNotificationType","kind":"json-schema","title":"RcsSenderNotificationType","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":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderNotificationType"}]},"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/RcsTestNumberFeatures":{"id":"components/schemas/RcsTestNumberFeatures","kind":"json-schema","title":"RcsTestNumberFeatures","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","description":"List of RBM features that this device supports.","uniqueItems":false,"items":{"$ref":"#/components/schemas/RcsTestNumberFeatures"}}},"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":{"readOnly":true,"description":"Launch questions specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"}]}},"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/RcsInputSenderUseCasesEnum":{"id":"components/schemas/RcsInputSenderUseCasesEnum","kind":"json-schema","title":"RcsInputSenderUseCasesEnum","data":{"type":"string","enum":["MULTIUSE","OTP","PROMOTIONAL","TRANSACTIONAL"]}},"components/schemas/RcsInputCountryCodesEnum":{"id":"components/schemas/RcsInputCountryCodesEnum","kind":"json-schema","title":"RcsInputCountryCodesEnum","data":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"]}},"components/schemas/SMSProvisioningStates":{"id":"components/schemas/SMSProvisioningStates","kind":"json-schema","title":"SMSProvisioningStates","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/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":{"description":"App region.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/SMSConversationApiAppRegionsEnum"}]},"channelStatus":{"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":{"description":"Status of SMS App.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/SMSProvisioningStates"}]},"regions":{"type":"array","description":"List of regions of the app.","uniqueItems":false,"items":{"type":"string","enum":["AU","BR","CA","EU","US","UNRECOGNIZED"]}},"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/SMSInputSmsAppRegions":{"id":"components/schemas/SMSInputSmsAppRegions","kind":"json-schema","title":"SMSInputSmsAppRegions","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":{"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/SMSInputSmsAppRegions"}]},"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_716":{"kind":"json-schema","data":{"type":"string"},"id":"schema_716"},"schema_717":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":15},"id":"schema_717"},"schema_718":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_718"},"schema_719":{"kind":"json-schema","data":{"example":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"title":"UnauthorizedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"unauthorized_error","example":"unauthorized_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Unauthorized error.","example":"Unauthorized error.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that projectId is correct.","example":"Verify that projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_719"},"schema_720":{"kind":"json-schema","data":{"example":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_720"},"schema_721":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["target must be a string","target must be a URL address"]},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_721"},"schema_722":{"kind":"json-schema","data":{"example":{"errorCode":"webhook_exists","message":"Webhook with the provided target already exists.","resolution":"Webhooks must have a unique target. Change the target and submit again."},"title":"WebhookExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"webhook_exists","example":"webhook_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Webhook with the provided target already exists.","example":"Webhook with the provided target already exists.","description":"Human readable message."},"resolution":{"type":"string","title":"Webhooks must have a unique target. Change the target and submit again.","example":"Webhooks must have a unique target. Change the target and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_722"},"schema_723":{"kind":"json-schema","data":{"example":{"errorCode":"webhook_limit_reached","message":"Number of webhooks has reached the limit.","resolution":"Delete some webhooks to be able to add more."},"title":"WebhookLimitReachedErrorTitle","properties":{"errorCode":{"type":"string","title":"webhook_limit_reached","example":"webhook_limit_reached","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Number of webhooks has reached the limit.","example":"Number of webhooks has reached the limit.","description":"Human readable message."},"resolution":{"type":"string","title":"Delete some webhooks to be able to add more.","example":"Delete some webhooks to be able to add more.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_723"},"schema_724":{"kind":"json-schema","data":{"example":{"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."},"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"webhookId param is in the wrong format. Confirm that you're sending the correct value.","example":"webhookId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_724"},"schema_725":{"kind":"json-schema","data":{"example":{"errorCode":"webhook_not_found","message":"Webhook not found.","resolution":"Verify that the parameters are correct."},"title":"WebhookNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"webhook_not_found","example":"webhook_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Webhook not found.","example":"Webhook not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_725"},"schema_726":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["target must be a string","target must be a URL address"]},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"webhookId param is in the wrong format. Confirm that you're sending the correct value.","example":"webhookId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_726"},"schema_727":{"kind":"json-schema","data":{"example":{"errorCode":"account_not_found","message":"Account not found.","resolution":"Verify that the parameters are correct."},"title":"AccountNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"account_not_found","example":"account_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account not found.","example":"Account not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_727"},"schema_728":{"kind":"json-schema","data":{"example":{"errorCode":"account_data_is_corrupt","message":"Account data is corrupt.","resolution":"Please contact support."},"title":"AccountDataIsCorruptErrorTitle","properties":{"errorCode":{"type":"string","title":"account_data_is_corrupt","example":"account_data_is_corrupt","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account data is corrupt.","example":"Account data is corrupt.","description":"Human readable message."},"resolution":{"type":"string","title":"Please contact support.","example":"Please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_728"},"schema_729":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/WhatsappInputAccountPartnerInitiatedDto"},{"$ref":"#/components/schemas/WhatsappInputAccountDtoDeprecated"}]},"id":"schema_729"},"schema_730":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["companyLegalName must be a string"]},"description":"Additional information for error."}}},{"title":"InvalidBusinessManagerForEnvironmentErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_business_manager_for_environment","example":"invalid_business_manager_for_environment","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid business manager for environment.","example":"Invalid business manager for environment.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","example":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_730"},"schema_731":{"kind":"json-schema","data":{"example":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_731"},"schema_732":{"kind":"json-schema","data":{"oneOf":[{"title":"AccountExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"account_exists","example":"account_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account already exists.","example":"Account already exists.","description":"Human readable message."},"resolution":{"type":"string","title":"There can only be one WhatsApp account for each project. Choose another one project to create a new WhatsApp account.","example":"There can only be one WhatsApp account for each project. Choose another one project to create a new WhatsApp account.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AccountDataIsCorruptErrorTitle","properties":{"errorCode":{"type":"string","title":"account_data_is_corrupt","example":"account_data_is_corrupt","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account data is corrupt.","example":"Account data is corrupt.","description":"Human readable message."},"resolution":{"type":"string","title":"Please contact support.","example":"Please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_732"},"schema_733":{"kind":"json-schema","data":{"type":"string","format":"SHA256-hash"},"id":"schema_733"},"schema_734":{"kind":"json-schema","data":{"type":"string","enum":["HmacSHA256"],"uniqueItems":false},"id":"schema_734"},"schema_735":{"kind":"json-schema","data":{"type":"string","format":"timestamp"},"id":"schema_735"},"schema_736":{"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_736"},"schema_737":{"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_737"},"schema_738":{"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_738"},"schema_739":{"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_739"},"schema_740":{"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_740"},"schema_741":{"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_741"},"schema_742":{"kind":"json-schema","data":{"example":{"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."},"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_742"},"schema_743":{"kind":"json-schema","data":{"oneOf":[{"title":"AccountHasSendersErrorTitle","properties":{"errorCode":{"type":"string","title":"account_has_senders","example":"account_has_senders","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account has senders.","example":"Account has senders.","description":"Human readable message."},"resolution":{"type":"string","title":"Delete senders before deleting the account.","example":"Delete senders before deleting the account.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"projectId":"projectId","senderIds":["437f8791-69ec-42af-9271-59b86b80178d","62550a35-2307-4ff1-86e4-41b0cbc7b7cb"]},"description":"Additional information for error."}}},{"title":"AccountHasSenderChangesErrorTitle","properties":{"errorCode":{"type":"string","title":"account_has_sender_changes","example":"account_has_sender_changes","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account has pending sender changes.","example":"Account has pending sender changes.","description":"Human readable message."},"resolution":{"type":"string","title":"All sender changes must be resolved before deleting the account. If the error persists, please contact support.","example":"All sender changes must be resolved before deleting the account. If the error persists, please contact support.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"projectId":"projectId"},"description":"Additional information for error."}}}]},"id":"schema_743"},"schema_744":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateCouldNotDeleteDraftsErrorTitle","properties":{"errorCode":{"type":"string","title":"template_could_not_delete_drafts","example":"template_could_not_delete_drafts","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Couldn't delete template drafts.","example":"Couldn't delete template drafts.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again later, if the error persists, please contact support.","example":"Please try again later, if the error persists, please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_744"},"schema_745":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["wabaName must be a string"]},"description":"Additional information for error."}}},{"title":"NoFieldsToUpdateErrorTitle","properties":{"errorCode":{"type":"string","title":"no_fields_to_update","example":"no_fields_to_update","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No fields to be updated.","example":"No fields to be updated.","description":"Human readable message."},"resolution":{"type":"string","title":"Supply at least one field to be updated.","example":"Supply at least one field to be updated.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoFieldsToUpdateErrorTitle","properties":{"errorCode":{"type":"string","title":"no_fields_to_update","example":"no_fields_to_update","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No fields to be updated.","example":"No fields to be updated.","description":"Human readable message."},"resolution":{"type":"string","title":"Supply at least one field to be updated.","example":"Supply at least one field to be updated.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_745"},"schema_746":{"kind":"json-schema","data":{"example":{"errorCode":"account_not_updatable","message":"Account is not updatable.","resolution":"Only account that are in \"REJECTED\" state can be updated."},"title":"AccountNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"account_not_updatable","example":"account_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account is not updatable.","example":"Account is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Only account that are in \"REJECTED\" state can be updated.","example":"Only account that are in \"REJECTED\" state can be updated.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_746"},"schema_747":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":100},"id":"schema_747"},"schema_748":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_748"},"schema_749":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["comment must be longer than or equal to 1 characters"]},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_749"},"schema_750":{"kind":"json-schema","data":{"example":{"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."},"title":"TemplateInsightsNotYetAvailableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_insights_not_yet_available","example":"template_insights_not_yet_available","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template Insights unavailable.","example":"Template Insights unavailable.","description":"Human readable message."},"resolution":{"type":"string","title":"Template Insights are not available yet for this WhatsApp Business account, please contact support.","example":"Template Insights are not available yet for this WhatsApp Business account, please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_750"},"schema_751":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["facebookToken must be a string"]},"description":"Additional information for error."}}},{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["facebookCode must be a string"]},"description":"Additional information for error."}}},{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["at least one of facebookToken or facebookCode must be provided"]},"description":"Additional information for error."}}},{"title":"InvalidFacebookTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_facebook_token","example":"invalid_facebook_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Facebook token is invalid or has expired","example":"Facebook token is invalid or has expired","description":"Human readable message."},"resolution":{"type":"string","title":"Check that token is correct, or create a new one and try again.","example":"Check that token is correct, or create a new one and try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidFacebookCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_facebook_code","example":"invalid_facebook_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Facebook code is invalid or has expired","example":"Facebook code is invalid or has expired","description":"Human readable message."},"resolution":{"type":"string","title":"Check that code is correct, or request a new one and try again.","example":"Check that code is correct, or request a new one and try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidBusinessManagerErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_business_manager","example":"invalid_business_manager","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid business manager.","example":"Invalid business manager.","description":"Human readable message."},"resolution":{"type":"string","title":"Check that business manager is correct for project.","example":"Check that business manager is correct for project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidBusinessManagerForEnvironmentErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_business_manager_for_environment","example":"invalid_business_manager_for_environment","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid business manager for environment.","example":"Invalid business manager for environment.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","example":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_751"},"schema_752":{"kind":"json-schema","data":{"oneOf":[{"title":"FacebookRequestLimitReachedErrorTitle","properties":{"errorCode":{"type":"string","title":"facebook_Request_limit_reached","example":"facebook_Request_limit_reached","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Facebook request limit reached.","example":"Facebook request limit reached.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again later.","example":"Please try again later.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"LogInFacebookRequiredErrorTitle","properties":{"errorCode":{"type":"string","title":"log_in_facebook_required","example":"log_in_facebook_required","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Log in to facebook required.","example":"Log in to facebook required.","description":"Human readable message."},"resolution":{"type":"string","title":"Log in to www.facebook.com and follow the instructions given.","example":"Log in to www.facebook.com and follow the instructions given.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_752"},"schema_753":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["facebookToken must be a string"]},"description":"Additional information for error."}}},{"title":"InvalidFacebookTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_facebook_token","example":"invalid_facebook_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Facebook token is invalid or has expired","example":"Facebook token is invalid or has expired","description":"Human readable message."},"resolution":{"type":"string","title":"Check that token is correct, or create a new one and try again.","example":"Check that token is correct, or create a new one and try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidBusinessManagerErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_business_manager","example":"invalid_business_manager","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid business manager.","example":"Invalid business manager.","description":"Human readable message."},"resolution":{"type":"string","title":"Check that business manager is correct for project.","example":"Check that business manager is correct for project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidBusinessManagerForEnvironmentErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_business_manager_for_environment","example":"invalid_business_manager_for_environment","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid business manager for environment.","example":"Invalid business manager for environment.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","example":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_753"},"schema_754":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FlowNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"flow_not_found","example":"flow_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Flow not found.","example":"Flow not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FlowScreensNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"flow_screens_not_found","example":"flow_screens_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Flow screens not found.","example":"Flow screens not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify if the flow screens exist.","example":"Verify if the flow screens exist.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_754"},"schema_755":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappSenderStatesEnum"}},"id":"schema_755"},"schema_756":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappSenderStatusesEnum"}},"id":"schema_756"},"schema_757":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidFilterStatesErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_filter_states","example":"invalid_filter_states","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid filterStates.","example":"Invalid filterStates.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the filterStates used are supported by the Provisioning API.","example":"Verify that the filterStates used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedCodes":"ACTIVE, IN_PROGRESS, INACTIVE, PENDING_VERIFICATION, SUSPENDED, ERROR"},"description":"Additional information for error."}}},{"title":"InvalidFilterStatusesErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_filter_statuses","example":"invalid_filter_statuses","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid filter statuses.","example":"Invalid filter statuses.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the filterStatuses used are supported by the Provisioning API.","example":"Verify that the filterStatuses used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedCodes":"DRAFT, ERROR, IN_PROGRESS, REJECTED"},"description":"Additional information for error."}}}]},"id":"schema_757"},"schema_758":{"kind":"json-schema","data":{"example":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_758"},"schema_759":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/WhatsappSenderInputEsDto"},{"$ref":"#/components/schemas/WhatsappInputSenderPhoneProvisioningDto"},{"$ref":"#/components/schemas/WhatsappInputSenderPartnerInitiatedDto"},{"$ref":"#/components/schemas/WhatsappSenderInputDtoDeprecated"}]},"id":"schema_759"},"schema_760":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["details should not be null or undefined"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidFacebookTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_facebook_token","example":"invalid_facebook_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Facebook token is invalid or has expired","example":"Facebook token is invalid or has expired","description":"Human readable message."},"resolution":{"type":"string","title":"Check that token is correct, or create a new one and try again.","example":"Check that token is correct, or create a new one and try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidBusinessManagerErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_business_manager","example":"invalid_business_manager","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid business manager.","example":"Invalid business manager.","description":"Human readable message."},"resolution":{"type":"string","title":"Check that business manager is correct for project.","example":"Check that business manager is correct for project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidBusinessManagerForEnvironmentErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_business_manager_for_environment","example":"invalid_business_manager_for_environment","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid business manager for environment.","example":"Invalid business manager for environment.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","example":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileInvalidMimeTypeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_invalid_mime_type","example":"file_invalid_mime_type","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: invalid file mime type.","example":"details.photoUrl: invalid file mime type.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with supported mime types: image/jpeg, image/png, image/webp.","example":"Try again with supported mime types: image/jpeg, image/png, image/webp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_760"},"schema_761":{"kind":"json-schema","data":{"oneOf":[{"title":"AccountDataIsCorruptErrorTitle","properties":{"errorCode":{"type":"string","title":"account_data_is_corrupt","example":"account_data_is_corrupt","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account data is corrupt.","example":"Account data is corrupt.","description":"Human readable message."},"resolution":{"type":"string","title":"Please contact support.","example":"Please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"WrongWabaIdErrorTitle","properties":{"errorCode":{"type":"string","title":"wrong_waba_id","example":"wrong_waba_id","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Different wabaId already exists for sub account / project.","example":"Different wabaId already exists for sub account / project.","description":"Human readable message."},"resolution":{"type":"string","title":"Please check if the WhatsApp Business Account is correct, or don't provide the WhatsApp Business Account in the request for this project.","example":"Please check if the WhatsApp Business Account is correct, or don't provide the WhatsApp Business Account in the request for this project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NotFoundWabaIdErrorTitle","properties":{"errorCode":{"type":"string","title":"not_found_waba_id","example":"not_found_waba_id","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Not found wabaId.","example":"Not found wabaId.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that exist any WhatsApp Business Account for sub account / project.","example":"Verify that exist any WhatsApp Business Account for sub account / project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TooManyWabaIdErrorTitle","properties":{"errorCode":{"type":"string","title":"too_many_waba_id","example":"too_many_waba_id","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Too many wabaId.","example":"Too many wabaId.","description":"Human readable message."},"resolution":{"type":"string","title":"We can't automatically select WhatsApp Business Account for this project, please provide WhatsApp Business Account in the request.","example":"We can't automatically select WhatsApp Business Account for this project, please provide WhatsApp Business Account in the request.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"WabaIdUsedErrorTitle","properties":{"errorCode":{"type":"string","title":"waba_id_used","example":"waba_id_used","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"WabaId is used.","example":"WabaId is used.","description":"Human readable message."},"resolution":{"type":"string","title":"WhatsApp Business Account is already used in another project. Use another id or create the sender under the correct project.","example":"WhatsApp Business Account is already used in another project. Use another id or create the sender under the correct project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"WrongBusinessManagerErrorTitle","properties":{"errorCode":{"type":"string","title":"wrong_business_manager","example":"wrong_business_manager","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Different business manager already exists for sub account / project.","example":"Different business manager already exists for sub account / project.","description":"Human readable message."},"resolution":{"type":"string","title":"Please check if the Business Manager is correct, or don't provide the Business Manager in the request for this project.","example":"Please check if the Business Manager is correct, or don't provide the Business Manager in the request for this project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UsedPhoneNumberIdErrorTitle","properties":{"errorCode":{"type":"string","title":"used_phone_number_id","example":"used_phone_number_id","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Used phoneNumberId.","example":"Used phoneNumberId.","description":"Human readable message."},"resolution":{"type":"string","title":"PhoneNumberId is used. Choose another one.","example":"PhoneNumberId is used. Choose another one.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ProvisionedPhoneNumberIdErrorTitle","properties":{"errorCode":{"type":"string","title":"provisioned_phone_number_id","example":"provisioned_phone_number_id","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Provisioned phoneNumberId.","example":"Provisioned phoneNumberId.","description":"Human readable message."},"resolution":{"type":"string","title":"PhoneNumberId is provisioned. Choose another one.","example":"PhoneNumberId is provisioned. Choose another one.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AllPhoneNumberIdProvisionedErrorTitle","properties":{"errorCode":{"type":"string","title":"all_phone_number_id_provisioned","example":"all_phone_number_id_provisioned","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"All phoneNumberId are provisioned.","example":"All phoneNumberId are provisioned.","description":"Human readable message."},"resolution":{"type":"string","title":"All phoneNumberId are provisioned. Add another one.","example":"All phoneNumberId are provisioned. Add another one.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidWabaIdOrPhoneNumberIdForRegionErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_waba_id_or_phone_number_id_for_region","example":"invalid_waba_id_or_phone_number_id_for_region","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid wabaId or phoneNumberId for region.","example":"Invalid wabaId or phoneNumberId for region.","description":"Human readable message."},"resolution":{"type":"string","title":"Please check if the WhatsApp Business Account, phone number id and region are correct.","example":"Please check if the WhatsApp Business Account, phone number id and region are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"file_not_found","example":"file_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: file not found.","example":"details.photoUrl: file not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the url is correct.","example":"Verify that the url is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileSizeTooLargeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_size_too_large","example":"file_size_too_large","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: file size is too large.","example":"details.photoUrl: file size is too large.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","example":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileHasWrongDimensionsErrorTitle","properties":{"errorCode":{"type":"string","title":"file_has_wrong_dimensions","example":"file_has_wrong_dimensions","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: image has wrong dimensions.","example":"details.photoUrl: image has wrong dimensions.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with image dimensions: min 192 x 192 px & max 640 x 640 px.","example":"Try again with image dimensions: min 192 x 192 px & max 640 x 640 px.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileUnexpectedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"file_unexpected_error","example":"file_unexpected_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: file unexpected error.","example":"details.photoUrl: file unexpected error.","description":"Human readable message."},"resolution":{"type":"string","title":"The file cannot be handled properly. Please try with another one.","example":"The file cannot be handled properly. Please try with another one.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_761"},"schema_762":{"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_762"},"schema_763":{"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_763"},"schema_764":{"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_764"},"schema_765":{"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_765"},"schema_766":{"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_766"},"schema_767":{"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_767"},"schema_768":{"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_768"},"schema_769":{"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_769"},"schema_770":{"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_770"},"schema_771":{"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_771"},"schema_772":{"kind":"json-schema","data":{"example":{"errorCode":"sender_already_deleted","message":"A sender has been deleted within 30 days.","resolution":"Wait the required time."},"title":"SenderAlreadyDeletedErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_already_deleted","example":"sender_already_deleted","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"A sender has been deleted within 30 days.","example":"A sender has been deleted within 30 days.","description":"Human readable message."},"resolution":{"type":"string","title":"Wait the required time.","example":"Wait the required time.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_772"},"schema_773":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoFieldsToUpdateErrorTitle","properties":{"errorCode":{"type":"string","title":"no_fields_to_update","example":"no_fields_to_update","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No fields to be updated.","example":"No fields to be updated.","description":"Human readable message."},"resolution":{"type":"string","title":"Supply at least one field to be updated.","example":"Supply at least one field to be updated.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileInvalidMimeTypeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_invalid_mime_type","example":"file_invalid_mime_type","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: invalid file mime type.","example":"details.photoUrl: invalid file mime type.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with supported mime types: image/jpeg, image/png, image/webp.","example":"Try again with supported mime types: image/jpeg, image/png, image/webp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_773"},"schema_774":{"kind":"json-schema","data":{"oneOf":[{"title":"SenderNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_updatable","example":"sender_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender is not updatable.","example":"Sender is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by senders with state: ACTIVE.","example":"Updates are only supported by senders with state: ACTIVE.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderChangesNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_changes_not_updatable","example":"sender_changes_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender is not updatable.","example":"Sender is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by senders changes with status: DRAFT, REJECTED.","example":"Updates are only supported by senders changes with status: DRAFT, REJECTED.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderUsernameUpdateNotAllowedErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_username_update_not_allowed","example":"sender_username_update_not_allowed","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender username update is not allowed.","example":"Sender username update is not allowed.","description":"Human readable message."},"resolution":{"type":"string","title":"Sender username cannot be updated once set.","example":"Sender username cannot be updated once set.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderUsernameUpdateNotAvailableErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_username_update_not_available","example":"sender_username_update_not_available","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender username update is not available.","example":"Sender username update is not available.","description":"Human readable message."},"resolution":{"type":"string","title":"Only \"ACTIVE\" senders can have their username updated.","example":"Only \"ACTIVE\" senders can have their username updated.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"file_not_found","example":"file_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: file not found.","example":"details.photoUrl: file not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the url is correct.","example":"Verify that the url is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileSizeTooLargeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_size_too_large","example":"file_size_too_large","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: file size is too large.","example":"details.photoUrl: file size is too large.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","example":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileHasWrongDimensionsErrorTitle","properties":{"errorCode":{"type":"string","title":"file_has_wrong_dimensions","example":"file_has_wrong_dimensions","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: image has wrong dimensions.","example":"details.photoUrl: image has wrong dimensions.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with image dimensions: min 192 x 192 px & max 640 x 640 px.","example":"Try again with image dimensions: min 192 x 192 px & max 640 x 640 px.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileUnexpectedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"file_unexpected_error","example":"file_unexpected_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.photoUrl: file unexpected error.","example":"details.photoUrl: file unexpected error.","description":"Human readable message."},"resolution":{"type":"string","title":"The file cannot be handled properly. Please try with another one.","example":"The file cannot be handled properly. Please try with another one.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_774"},"schema_775":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_775"},"schema_776":{"kind":"json-schema","data":{"example":{"errorCode":"sender_changes_not_found","message":"Sender changes not found.","resolution":"Verify that the parameters are correct."},"title":"SenderChangesNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_changes_not_found","example":"sender_changes_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender changes not found.","example":"Sender changes not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_776"},"schema_777":{"kind":"json-schema","data":{"example":{"errorCode":"sender_changes_not_deletable","message":"Sender changes is not deletable.","resolution":"Only DRAFT, REJECTED, ERROR senders changes can be marked for deletion."},"title":"SenderChangesNotDeletableErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_changes_not_deletable","example":"sender_changes_not_deletable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender changes is not deletable.","example":"Sender changes is not deletable.","description":"Human readable message."},"resolution":{"type":"string","title":"Only DRAFT, REJECTED, ERROR senders changes can be marked for deletion.","example":"Only DRAFT, REJECTED, ERROR senders changes can be marked for deletion.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_777"},"schema_778":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["comment must be longer than or equal to 1 characters"]},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_778"},"schema_779":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["method must be one of the following values: SMS, VOICE"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_779"},"schema_780":{"kind":"json-schema","data":{"oneOf":[{"title":"NotAllowedRegisterErrorTitle","properties":{"errorCode":{"type":"string","title":"not_allowed_register","example":"not_allowed_register","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not allowed to be registered.","example":"Sender not allowed to be registered.","description":"Human readable message."},"resolution":{"type":"string","title":"Only \"PENDING_VERIFICATION\" sender can be registered.","example":"Only \"PENDING_VERIFICATION\" sender can be registered.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderNumberNotApprovedForEnterpriseErrorTitle","properties":{"errorCode":{"type":"string","title":"sender-number-not-approved-for-enterprise","example":"sender-number-not-approved-for-enterprise","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender number not approved for enterprise.","example":"Sender number not approved for enterprise.","description":"Human readable message."},"resolution":{"type":"string","title":"This number has not been approved for an enterprise. Please contact support for more info.","example":"This number has not been approved for an enterprise. Please contact support for more info.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_780"},"schema_781":{"kind":"json-schema","data":{"oneOf":[{"title":"SenderRegisterTooManyRequestsErrorTitle","properties":{"errorCode":{"type":"string","title":"sender-register-too-many-requests","example":"sender-register-too-many-requests","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender register too many requests.","example":"Sender register too many requests.","description":"Human readable message."},"resolution":{"type":"string","title":"Register sender request limits reached. Please try again later.","example":"Register sender request limits reached. Please try again later.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderAlreadyRegisteredErrorTitle","properties":{"errorCode":{"type":"string","title":"sender-already-registered","example":"sender-already-registered","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender already registered.","example":"Sender already registered.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TooManyInvalidVerificationCodesErrorTitle","properties":{"errorCode":{"type":"string","title":"too_many_invalid_verification_codes","example":"too_many_invalid_verification_codes","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Too many invalid verification codes.","example":"Too many invalid verification codes.","description":"Human readable message."},"resolution":{"type":"string","title":"You've tried too many invalid verification codes. Please try again later.","example":"You've tried too many invalid verification codes. Please try again later.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_781"},"schema_782":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["code must be a string","code must be exactly 6 characters"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_782"},"schema_783":{"kind":"json-schema","data":{"oneOf":[{"title":"NotAllowedVerifyErrorTitle","properties":{"errorCode":{"type":"string","title":"not_allowed_verify","example":"not_allowed_verify","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not allowed to be verified.","example":"Sender not allowed to be verified.","description":"Human readable message."},"resolution":{"type":"string","title":"Only \"PENDING_VERIFICATION\" sender can be verified.","example":"Only \"PENDING_VERIFICATION\" sender can be verified.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"WrongOtpErrorTitle","properties":{"errorCode":{"type":"string","title":"wrong_otp","example":"wrong_otp","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender verification failed due to wrong OTP.","example":"Sender verification failed due to wrong OTP.","description":"Human readable message."},"resolution":{"type":"string","title":"Please make sure that the correct OTP code is entered.","example":"Please make sure that the correct OTP code is entered.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_783"},"schema_784":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SolutionNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"solution_not_found","example":"solution_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Solution not found.","example":"Solution not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_784"},"schema_785":{"kind":"json-schema","data":{"example":{"errorCode":"solution_cannot_be_reassigned","message":"Project is already onboarded, can't reassign solution","resolution":"Verify that the parameters are correct."},"title":"SolutionCannotBeReassignedErrorTitle","properties":{"errorCode":{"type":"string","title":"solution_cannot_be_reassigned","example":"solution_cannot_be_reassigned","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project is already onboarded, can't reassign solution","example":"Project is already onboarded, can't reassign solution","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_785"},"schema_786":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":1000},"id":"schema_786"},"schema_787":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateDtoFieldMaskPathsEnum"}},"id":"schema_787"},"schema_788":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateStatesEnum"}},"id":"schema_788"},"schema_789":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateStatusesEnum"}},"id":"schema_789"},"schema_790":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsDateRangesEnum"},"id":"schema_790"},"schema_791":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/WhatsappTemplateListDto"},{"$ref":"#/components/schemas/WhatsappPartialTemplateListDto"}]},"id":"schema_791"},"schema_792":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidFilterStatesErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_filter_states","example":"invalid_filter_states","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid filterStates.","example":"Invalid filterStates.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the filterStates used are supported by the Provisioning API.","example":"Verify that the filterStates used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedCodes":"APPROVED, DISABLED, PAUSED, REJECTED"},"description":"Additional information for error."}}},{"title":"InvalidFilterStatusesErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_filter_statuses","example":"invalid_filter_statuses","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid filter statuses.","example":"Invalid filter statuses.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the filterStatuses used are supported by the Provisioning API.","example":"Verify that the filterStatuses used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedCodes":"DRAFT, IN_PROGRESS, REJECTED"},"description":"Additional information for error."}}},{"title":"InvalidFieldsErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_fields","example":"invalid_fields","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid fields.","example":"Invalid fields.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the fields used are supported by the Provisioning API.","example":"Verify that the fields used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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.messageSendTtlSeconds, 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.messageSendTtlSeconds, 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"},"description":"Additional information for error."}}}]},"id":"schema_792"},"schema_793":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["category must be one of the following values: AUTHENTICATION, MARKETING, UTILITY"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplatePoliciesViolationsErrorTitle","properties":{"errorCode":{"type":"string","title":"template_policies_violations","example":"template_policies_violations","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Your message couldn't be sent because it includes content that other people on Facebook have reported as abusive.","example":"Your message couldn't be sent because it includes content that other people on Facebook have reported as abusive.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateCheckMediaFileSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_check_media_file_size","example":"template_check_media_file_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Failed to check media file size.","example":"Failed to check media file size.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidCategoryErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_category","example":"template_invalid_category","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template invalid category.","example":"Template invalid category.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that categories are correct: AUTHENTICATION, MARKETING, UTILITY.","example":"Verify that categories are correct: AUTHENTICATION, MARKETING, UTILITY.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidButtonExampleErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_button_example","example":"template_invalid_button_example","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid button example.","example":"Invalid button example.","description":"Human readable message."},"resolution":{"type":"string","title":"Only dynamic URL buttons are allowed to have an example.","example":"Only dynamic URL buttons are allowed to have an example.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateMediaFileSizeExceedsMaximumFileSizeLimitErrorTitle","properties":{"errorCode":{"type":"string","title":"template_media_file_size_exceeds_maximum_file_size_limit","example":"template_media_file_size_exceeds_maximum_file_size_limit","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template media file size exceeds maximum file size limit.","example":"Template media file size exceeds maximum file size limit.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file.","example":"Try again with a smaller file.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileInvalidMimeTypeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_invalid_mime_type","example":"file_invalid_mime_type","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: invalid file mime type.","example":"details.components[0].headerExample.media.url: invalid file mime type.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with supported mime types: image/jpeg, image/png, application/pdf, video/3gp, video/mp4.","example":"Try again with supported mime types: image/jpeg, image/png, application/pdf, video/3gp, video/mp4.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_793"},"schema_794":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"template_exists","example":"template_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template already exists.","example":"Template already exists.","description":"Human readable message."},"resolution":{"type":"string","title":"Templates must have unique name and language. Change language or name and submit again.","example":"Templates must have unique name and language. Change language or name and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}},{"title":"TemplateNameRecentlyUsedErrorTitle","properties":{"errorCode":{"type":"string","title":"template_name_recently_used","example":"template_name_recently_used","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"A template with the same name has been deleted within 30 days.","example":"A template with the same name has been deleted within 30 days.","description":"Human readable message."},"resolution":{"type":"string","title":"Use another \"name\" for \"EN\" or wait the required time.","example":"Use another \"name\" for \"EN\" or wait the required time.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateIncorrectCategoryErrorTitle","properties":{"errorCode":{"type":"string","title":"template_incorrect_category","example":"template_incorrect_category","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template incorrect category.","example":"Template incorrect category.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a category that has been used in another language: \"UTILITY\".","example":"Use a category that has been used in another language: \"UTILITY\".","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateRestrictedDomainForButtonUrlErrorTitle","properties":{"errorCode":{"type":"string","title":"template_restricted_Domain_for_button_url","example":"template_restricted_Domain_for_button_url","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Restricted domain for button url.","example":"Restricted domain for button url.","description":"Human readable message."},"resolution":{"type":"string","title":"Replace any of the following restricted domains: wa.me, whatsapp.com","example":"Replace any of the following restricted domains: wa.me, whatsapp.com","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"file_not_found","example":"file_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: file not found.","example":"details.components[0].headerExample.media.url: file not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the url is correct.","example":"Verify that the url is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileSizeTooLargeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_size_too_large","example":"file_size_too_large","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: file size is too large.","example":"details.components[0].headerExample.media.url: file size is too large.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","example":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileUnexpectedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"file_unexpected_error","example":"file_unexpected_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: file unexpected error.","example":"details.components[0].headerExample.media.url: file unexpected error.","description":"Human readable message."},"resolution":{"type":"string","title":"The file cannot be handled properly. Please try with another one.","example":"The file cannot be handled properly. Please try with another one.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ObjectWithWhatsappBusinessAccountIdDoesNotExistErrorTitle","properties":{"errorCode":{"type":"string","title":"object_with_whatsapp_business_account_id_does_not_exist","example":"object_with_whatsapp_business_account_id_does_not_exist","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"WhatsApp Business Account does not exist.","example":"WhatsApp Business Account does not exist.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that WhatsApp Business ID still exists and contact support.","example":"Verify that WhatsApp Business ID still exists and contact support.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateLanguageRecentlyDeletedErrorTitle","properties":{"errorCode":{"type":"string","title":"template_language_recently_deleted","example":"template_language_recently_deleted","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"A template with the same language has been deleted within 4 weeks.","example":"A template with the same language has been deleted within 4 weeks.","description":"Human readable message."},"resolution":{"type":"string","title":"Try to create EN content again in 4 weeks or create a new template.","example":"Try to create EN content again in 4 weeks or create a new template.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_794"},"schema_795":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateLimitReachedErrorTitle","properties":{"errorCode":{"type":"string","title":"template_limit_reached","example":"template_limit_reached","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Number of templates has reached the limit.","example":"Number of templates has reached the limit.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateContentAlreadyExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"template_content_already_exists","example":"template_content_already_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template cannot be submitted because the content is the same as the content in another template.","example":"Template cannot be submitted because the content is the same as the content in another template.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateSubmitErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"template_submit_error","example":"template_submit_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template submit error.","example":"Template submit error.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"metaError":{"code":"123","subcode":"123456","message":"Invalid parameter","description":"Character Limit Exceeded","reason":"field 'name' can't have more than 1,024 characters"}},"description":"Additional information for error."}}}]},"id":"schema_795"},"schema_796":{"kind":"json-schema","data":{"example":{"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."},"title":"WhatsappBusinessApiRequestLimitExceededErrorTitle","properties":{"errorCode":{"type":"string","title":"whatsapp_business_api_request_limit_exceeded","example":"whatsapp_business_api_request_limit_exceeded","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"WhatsApp business api request limit reached.","example":"WhatsApp business api request limit reached.","description":"Human readable message."},"resolution":{"type":"string","title":"WhatsApp business API request limits reached. Please try again later.","example":"WhatsApp business API request limits reached. Please try again later.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_796"},"schema_797":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateStartSessionForUploadingMediaErrorTitle","properties":{"errorCode":{"type":"string","title":"template_start_session_for_uploading_media","example":"template_start_session_for_uploading_media","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Failed to start session for uploading template media example.","example":"Failed to start session for uploading template media example.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_797"},"schema_798":{"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_798"},"schema_799":{"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_799"},"schema_800":{"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_800"},"schema_801":{"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"]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload","newState"]},"id":"schema_801"},"schema_802":{"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_802"},"schema_803":{"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_803"},"schema_804":{"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_804"},"schema_805":{"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"]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload","futureCategory"]},"id":"schema_805"},"schema_806":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidFieldsErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_fields","example":"invalid_fields","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid fields.","example":"Invalid fields.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the fields used are supported by the Provisioning API.","example":"Verify that the fields used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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.messageSendTtlSeconds, 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.messageSendTtlSeconds, 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"},"description":"Additional information for error."}}}]},"id":"schema_806"},"schema_807":{"kind":"json-schema","data":{"example":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"title":"TemplateNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_found","example":"template_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template not found.","example":"Template not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_807"},"schema_808":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidLanguageCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_language_code","example":"template_invalid_language_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid language code.","example":"Invalid language code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","example":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}}]},"id":"schema_808"},"schema_809":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WhatsappTemplateLanguagesEnum"},"id":"schema_809"},"schema_810":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"},{"$ref":"#/components/schemas/WhatsappPartialTemplateDto"}]},"id":"schema_810"},"schema_811":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidLanguageCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_language_code","example":"template_invalid_language_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid language code.","example":"Invalid language code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","example":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}},{"title":"InvalidFieldsErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_fields","example":"invalid_fields","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid fields.","example":"Invalid fields.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the fields used are supported by the Provisioning API.","example":"Verify that the fields used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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.messageSendTtlSeconds, 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.messageSendTtlSeconds, 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"},"description":"Additional information for error."}}}]},"id":"schema_811"},"schema_812":{"kind":"json-schema","data":{"default":false,"type":"boolean"},"id":"schema_812"},"schema_813":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_found","example":"template_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template not found.","example":"Template not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateChangesNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"template_changes_not_found","example":"template_changes_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template changes not found.","example":"Template changes not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the template has pending changes.","example":"Verify that the template has pending changes.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_813"},"schema_814":{"kind":"json-schema","data":{"example":{"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."},"title":"TemplateNotDeletableDueToInputConfigErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_deletable_due_to_input_config","example":"template_not_deletable_due_to_input_config","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template is not deletable due to input config.","example":"Template is not deletable due to input config.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_814"},"schema_815":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidLanguageCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_language_code","example":"template_invalid_language_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid language code.","example":"Invalid language code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","example":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}},{"title":"TemplatePoliciesViolationsErrorTitle","properties":{"errorCode":{"type":"string","title":"template_policies_violations","example":"template_policies_violations","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Your message couldn't be sent because it includes content that other people on Facebook have reported as abusive.","example":"Your message couldn't be sent because it includes content that other people on Facebook have reported as abusive.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateCheckMediaFileSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_check_media_file_size","example":"template_check_media_file_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Failed to check media file size.","example":"Failed to check media file size.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidButtonExampleErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_button_example","example":"template_invalid_button_example","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid button example.","example":"Invalid button example.","description":"Human readable message."},"resolution":{"type":"string","title":"Only dynamic URL buttons are allowed to have an example.","example":"Only dynamic URL buttons are allowed to have an example.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateMediaFileSizeExceedsMaximumFileSizeLimitErrorTitle","properties":{"errorCode":{"type":"string","title":"template_media_file_size_exceeds_maximum_file_size_limit","example":"template_media_file_size_exceeds_maximum_file_size_limit","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template media file size exceeds maximum file size limit.","example":"Template media file size exceeds maximum file size limit.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file.","example":"Try again with a smaller file.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileInvalidMimeTypeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_invalid_mime_type","example":"file_invalid_mime_type","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: invalid file mime type.","example":"details.components[0].headerExample.media.url: invalid file mime type.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with supported mime types: image/jpeg, image/png, application/pdf, video/3gp, video/mp4.","example":"Try again with supported mime types: image/jpeg, image/png, application/pdf, video/3gp, video/mp4.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_815"},"schema_816":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_updatable","example":"template_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template is not updatable.","example":"Template is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by templates with state: APPROVED, DISABLED, PAUSED, REJECTED.","example":"Updates are only supported by templates with state: APPROVED, DISABLED, PAUSED, REJECTED.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateChangesNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_changes_not_updatable","example":"template_changes_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template is not updatable.","example":"Template is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by template changes with status: DRAFT, REJECTED.","example":"Updates are only supported by template changes with status: DRAFT, REJECTED.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateCategoryNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_category_not_updatable","example":"template_category_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template category is not updatable.","example":"Template category is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by template with state: DRAFT or with state: REJECTED and rejectionCode: INCORRECT_CATEGORY.","example":"Updates are only supported by template with state: DRAFT or with state: REJECTED and rejectionCode: INCORRECT_CATEGORY.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateAllowCategoryChangeNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_allow_category_change_not_updatable","example":"template_allow_category_change_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template allowCategoryChange is not updatable.","example":"Template allowCategoryChange is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by template with state: DRAFT or with state: REJECTED and rejectionCode: INCORRECT_CATEGORY.","example":"Updates are only supported by template with state: DRAFT or with state: REJECTED and rejectionCode: INCORRECT_CATEGORY.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateSourceNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_source_not_updatable","example":"template_source_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template is not updatable.","example":"Template is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Templates generated by Meta cannot be updated.","example":"Templates generated by Meta cannot be updated.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateNameRecentlyUsedErrorTitle","properties":{"errorCode":{"type":"string","title":"template_name_recently_used","example":"template_name_recently_used","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"A template with the same name has been deleted within 30 days.","example":"A template with the same name has been deleted within 30 days.","description":"Human readable message."},"resolution":{"type":"string","title":"Use another \"name\" for \"EN\" or wait the required time.","example":"Use another \"name\" for \"EN\" or wait the required time.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateRestrictedDomainForButtonUrlErrorTitle","properties":{"errorCode":{"type":"string","title":"template_restricted_Domain_for_button_url","example":"template_restricted_Domain_for_button_url","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Restricted domain for button url.","example":"Restricted domain for button url.","description":"Human readable message."},"resolution":{"type":"string","title":"Replace any of the following restricted domains: wa.me, whatsapp.com","example":"Replace any of the following restricted domains: wa.me, whatsapp.com","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"file_not_found","example":"file_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: file not found.","example":"details.components[0].headerExample.media.url: file not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the url is correct.","example":"Verify that the url is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileSizeTooLargeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_size_too_large","example":"file_size_too_large","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: file size is too large.","example":"details.components[0].headerExample.media.url: file size is too large.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","example":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileUnexpectedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"file_unexpected_error","example":"file_unexpected_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.components[0].headerExample.media.url: file unexpected error.","example":"details.components[0].headerExample.media.url: file unexpected error.","description":"Human readable message."},"resolution":{"type":"string","title":"The file cannot be handled properly. Please try with another one.","example":"The file cannot be handled properly. Please try with another one.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ObjectWithWhatsappBusinessAccountIdDoesNotExistErrorTitle","properties":{"errorCode":{"type":"string","title":"object_with_whatsapp_business_account_id_does_not_exist","example":"object_with_whatsapp_business_account_id_does_not_exist","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"WhatsApp Business Account does not exist.","example":"WhatsApp Business Account does not exist.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that WhatsApp Business ID still exists and contact support.","example":"Verify that WhatsApp Business ID still exists and contact support.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateLanguageRecentlyDeletedErrorTitle","properties":{"errorCode":{"type":"string","title":"template_language_recently_deleted","example":"template_language_recently_deleted","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"A template with the same language has been deleted within 4 weeks.","example":"A template with the same language has been deleted within 4 weeks.","description":"Human readable message."},"resolution":{"type":"string","title":"Try to create EN content again in 4 weeks or create a new template.","example":"Try to create EN content again in 4 weeks or create a new template.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_816"},"schema_817":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidLanguageCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_language_code","example":"template_invalid_language_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid language code.","example":"Invalid language code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","example":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_817"},"schema_818":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["comment must be longer than or equal to 1 characters"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidLanguageCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_language_code","example":"template_invalid_language_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid language code.","example":"Invalid language code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","example":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_818"},"schema_819":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["templates must be an array","templates must contain no more than 1 elements","templates must contain at least 1 elements"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for WhatsApp.","example":"Project not initialized for WhatsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","example":"Verify that the project ID is correct and that it has been onboarded for WhatsApp.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidLanguageCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_language_code","example":"template_invalid_language_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid language code.","example":"Invalid language code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","example":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_819"},"schema_820":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_found","example":"template_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template not found.","example":"Template not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplatesCompareNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"templates_compare_not_found","example":"templates_compare_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Templates to compare not found.","example":"Templates to compare not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct. No templates found for templateName: templateName and templateLanguage: EN","example":"Verify that the parameters are correct. No templates found for templateName: templateName and templateLanguage: EN","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_820"},"schema_821":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplatesNotEligibleForComparisonErrorTitle","properties":{"errorCode":{"type":"string","title":"templates_not_eligible_for_comparison","example":"templates_not_eligible_for_comparison","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Templates not eligible for comparison.","example":"Templates not eligible for comparison.","description":"Human readable message."},"resolution":{"type":"string","title":"Templates must have been sent at least 1,000 times in the specified timeframe.","example":"Templates must have been sent at least 1,000 times in the specified timeframe.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplatesCompareNotUniqueErrorTitle","properties":{"errorCode":{"type":"string","title":"templates_compare_not_unique","example":"templates_compare_not_unique","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Templates to compare not unique.","example":"Templates to compare not unique.","description":"Human readable message."},"resolution":{"type":"string","title":"Template can't be compared with itself. Provide unique templates for comparison.","example":"Template can't be compared with itself. Provide unique templates for comparison.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_821"},"schema_822":{"kind":"json-schema","data":{"example":{"errorCode":"too_many_requests","message":"Too many requests.","resolution":"Please wait and try again."},"title":"TooManyRequestsErrorTitle","properties":{"errorCode":{"type":"string","title":"too_many_requests","example":"too_many_requests","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Too many requests.","example":"Too many requests.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again.","example":"Please wait and try again.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_822"},"schema_823":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":25},"id":"schema_823"},"schema_824":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_824"},"schema_825":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BundlesBundleServicesStateEnum"}},"id":"schema_825"},"schema_826":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"projectId param is in the wrong format. Confirm that you're sending the correct value.","example":"projectId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_826"},"schema_827":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/BundlesInputBundlesDto"}]},"id":"schema_827"},"schema_828":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["subproject must be boolean or object"]},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoServicesToCreateErrorTitle","properties":{"errorCode":{"type":"string","title":"no_services_to_create","example":"no_services_to_create","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No services to create.","example":"No services to create.","description":"Human readable message."},"resolution":{"type":"string","title":"Add at least one service to create.","example":"Add at least one service to create.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"MissingNameErrorTitle","properties":{"errorCode":{"type":"string","title":"missing_name","example":"missing_name","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Missing name for bundles.","example":"Missing name for bundles.","description":"Human readable message."},"resolution":{"type":"string","title":"Make sure you have given a separate service name or principal.","example":"Make sure you have given a separate service name or principal.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidWebhooksErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_webhooks","example":"invalid_webhooks","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Unable to create webhooks.","example":"Unable to create webhooks.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again.","example":"Please try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidStagingBundlesInputRegionErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_staging_bundles_input_region","example":"invalid_staging_bundles_input_region","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid bundles region for staging.","example":"Invalid bundles region for staging.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that bundles region is valid for staging. Allowed bundles regions for staging EU, US.","example":"Verify that bundles region is valid for staging. Allowed bundles regions for staging EU, US.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ConversationAppAlreadyConnectedToSmsAppErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_already_connected_to_sms_app","example":"conversation_app_already_connected_to_sms_app","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation App is already connected to an SMS App.","example":"Conversation App is already connected to an SMS App.","description":"Human readable message."},"resolution":{"type":"string","title":"Use the SMS App that is already connected to the Conversation App or disconnect the currently connected SMS App before connecting another SMS App.","example":"Use the SMS App that is already connected to the Conversation App or disconnect the currently connected SMS App before connecting another SMS App.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_828"},"schema_829":{"kind":"json-schema","data":{"example":{"errorCode":"forbidden_payload","message":"Forbidden payload.","resolution":"Please ensure that you have permission to use that payload."},"title":"ForbiddenPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"forbidden_payload","example":"forbidden_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Forbidden payload.","example":"Forbidden payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Please ensure that you have permission to use that payload.","example":"Please ensure that you have permission to use that payload.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_829"},"schema_830":{"kind":"json-schema","data":{"oneOf":[{"title":"ConversationAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_not_found","example":"conversation_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation App not found.","example":"Conversation App not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the appId is correct.","example":"Verify that the appId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SmsAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sms_app_not_found","example":"sms_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"SmsApp not found.","example":"SmsApp not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the appId is correct.","example":"Verify that the appId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"DefaultSmsAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"default_sms_app_not_found","example":"default_sms_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Default SmsApp not found.","example":"Default SmsApp not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Create SmsApp in test mode to use in request.","example":"Create SmsApp in test mode to use in request.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_830"},"schema_831":{"kind":"json-schema","data":{"oneOf":[{"title":"WebhookExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"webhook_exists","example":"webhook_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Webhook with the provided target already exists.","example":"Webhook with the provided target already exists.","description":"Human readable message."},"resolution":{"type":"string","title":"Webhooks must have a unique target. Change the target and submit again.","example":"Webhooks must have a unique target. Change the target and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ConversationAppIsAlreadyInBundlesProcessErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_is_already_in_bundles_process","example":"conversation_app_is_already_in_bundles_process","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation App is already in Bundles process.","example":"Conversation App is already in Bundles process.","description":"Human readable message."},"resolution":{"type":"string","title":"Please select another conversationAppId for which the request is to be made.","example":"Please select another conversationAppId for which the request is to be made.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"MoreThanOneSmsAppErrorTitle","properties":{"errorCode":{"type":"string","title":"more_than_one_sms_app","example":"more_than_one_sms_app","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"More than one SmsApp.","example":"More than one SmsApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Please select the smsAppId for which the request is to be made.","example":"Please select the smsAppId for which the request is to be made.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SmsAppIsAlreadyLinkedToConversationAppErrorTitle","properties":{"errorCode":{"type":"string","title":"sms_app_is_already_linked_to_conversation_app","example":"sms_app_is_already_linked_to_conversation_app","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"SmsApp is already linked to ConversationApp.","example":"SmsApp is already linked to ConversationApp.","description":"Human readable message."},"resolution":{"type":"string","title":"Please select another smsAppId for which the request is to be made.","example":"Please select another smsAppId for which the request is to be made.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SmsAppIsAlreadyInBundlesProcessErrorTitle","properties":{"errorCode":{"type":"string","title":"sms_app_is_already_in_bundles_process","example":"sms_app_is_already_in_bundles_process","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"SmsApp is already in Bundles process.","example":"SmsApp is already in Bundles process.","description":"Human readable message."},"resolution":{"type":"string","title":"Please select another smsAppId for which the request is to be made.","example":"Please select another smsAppId for which the request is to be made.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AllowedOnlyForDefaultTestSmsAppErrorTitle","properties":{"errorCode":{"type":"string","title":"allowed_only_for_default_test_sms_app","example":"allowed_only_for_default_test_sms_app","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Allowed only for default test SMS app.","example":"Allowed only for default test SMS app.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the SMS app is marked as defaultTest.","example":"Verify that the SMS app is marked as defaultTest.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NotAllowedForSubprojectErrorTitle","properties":{"errorCode":{"type":"string","title":"not_allowed_for_subproject","example":"not_allowed_for_subproject","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Not allowed for subproject.","example":"Not allowed for subproject.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the subproject is eligible for test numbers.","example":"Verify that the subproject is eligible for test numbers.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NotAllowedForNonTestAccountErrorTitle","properties":{"errorCode":{"type":"string","title":"not_allowed_for_non_test_account","example":"not_allowed_for_non_test_account","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Not allowed for non test account.","example":"Not allowed for non test account.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the account is a test account.","example":"Verify that the account is a test account.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"OnlyOneTestNumberAllowedErrorTitle","properties":{"errorCode":{"type":"string","title":"only_one_test_number_allowed","example":"only_one_test_number_allowed","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Only one active test number is allowed per project.","example":"Only one active test number is allowed per project.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that there are no other active test numbers in the project.","example":"Verify that there are no other active test numbers in the project.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_831"},"schema_832":{"kind":"json-schema","data":{"oneOf":[{"title":"FailedToCreateSubprojectErrorTitle","properties":{"errorCode":{"type":"string","title":"failed_to_create_subproject","example":"failed_to_create_subproject","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Failed to create subproject.","example":"Failed to create subproject.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again.","example":"Please try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FailedToCreateSmsServiceErrorTitle","properties":{"errorCode":{"type":"string","title":"failed_to_create_sms_service","example":"failed_to_create_sms_service","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Failed to create sms service.","example":"Failed to create sms service.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again.","example":"Please try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FailedToCreateConversationServiceErrorTitle","properties":{"errorCode":{"type":"string","title":"failed_to_create_conversation_service","example":"failed_to_create_conversation_service","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Failed to create conversation service.","example":"Failed to create conversation service.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again.","example":"Please try again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_832"},"schema_833":{"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_833"},"schema_834":{"kind":"json-schema","data":{"example":{"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."},"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"bundleId param is in the wrong format. Confirm that you're sending the correct value.","example":"bundleId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_834"},"schema_835":{"kind":"json-schema","data":{"oneOf":[{"title":"BundleNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"bundle_not_found","example":"bundle_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Bundle not found.","example":"Bundle not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ConversationAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_not_found","example":"conversation_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation App not found.","example":"Conversation App not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the appId is correct.","example":"Verify that the appId is correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_835"},"schema_836":{"kind":"json-schema","data":{"example":{"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."},"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_836"},"schema_837":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_837"},"schema_838":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderStatesEnum"}},"id":"schema_838"},"schema_839":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderStatusesEnum"}},"id":"schema_839"},"schema_840":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidFilterStatesErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_filter_states","example":"invalid_filter_states","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid filterStates.","example":"Invalid filterStates.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the filterStates used are supported by the Provisioning API.","example":"Verify that the filterStates used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedCodes":"ACTIVE, BLOCKED, INACTIVE, SUSPENDED, VERIFYING"},"description":"Additional information for error."}}},{"title":"InvalidFilterStatusesErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_filter_statuses","example":"invalid_filter_statuses","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid filter statuses.","example":"Invalid filter statuses.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the filterStatuses used are supported by the Provisioning API.","example":"Verify that the filterStatuses used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedCodes":"DRAFT, IN_PROGRESS, REJECTED"},"description":"Additional information for error."}}}]},"id":"schema_840"},"schema_841":{"kind":"json-schema","data":{"oneOf":[{"title":"FileInvalidMimeTypeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_invalid_mime_type","example":"file_invalid_mime_type","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: invalid file mime type.","example":"details.logoImage: invalid file mime type.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with supported mime types: image/jpeg, image/png.","example":"Try again with supported mime types: image/jpeg, image/png.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderInvalidCategoryCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_invalid_category_code","example":"sender_invalid_category_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid sender category code(s).","example":"Invalid sender category code(s).","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the sender category code(s) used is supported.","example":"Verify that the sender category code(s) used is supported.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["plusFriendId must be longer than or equal to 1 characters"]},"description":"Additional information for error."}}}]},"id":"schema_841"},"schema_842":{"kind":"json-schema","data":{"oneOf":[{"title":"AccountExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"account_exists","example":"account_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account already exists.","example":"Account already exists.","description":"Human readable message."},"resolution":{"type":"string","title":"There can only be one KakaoTalk account for each project.","example":"There can only be one KakaoTalk account for each project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AccountNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"account_not_updatable","example":"account_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account is not updatable.","example":"Account is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Please contact support.","example":"Please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AccountDataIsCorruptErrorTitle","properties":{"errorCode":{"type":"string","title":"account_data_is_corrupt","example":"account_data_is_corrupt","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account data is corrupt.","example":"Account data is corrupt.","description":"Human readable message."},"resolution":{"type":"string","title":"Please contact support.","example":"Please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"file_not_found","example":"file_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: file not found.","example":"details.logoImage: file not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the url is correct.","example":"Verify that the url is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileUnexpectedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"file_unexpected_error","example":"file_unexpected_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: file unexpected error.","example":"details.logoImage: file unexpected error.","description":"Human readable message."},"resolution":{"type":"string","title":"The file cannot be handled properly. Please try with another one.","example":"The file cannot be handled properly. Please try with another one.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileSizeTooLargeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_size_too_large","example":"file_size_too_large","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: file size is too large.","example":"details.logoImage: file size is too large.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","example":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"PlusFriendIdUsedErrorTitle","properties":{"errorCode":{"type":"string","title":"plus_friend_id_used","example":"plus_friend_id_used","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"plusFriendId is already used.","example":"plusFriendId is already used.","description":"Human readable message."},"resolution":{"type":"string","title":"plusFriendId is already used by another Sender, verify that the parameters are correct.","example":"plusFriendId is already used by another Sender, verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_842"},"schema_843":{"kind":"json-schema","data":{"example":{"errorCode":"account_is_in_progress","message":"Account creation is in progress.","resolution":"Please contact support."},"title":"AccountIsInProgressErrorTitle","properties":{"errorCode":{"type":"string","title":"account_is_in_progress","example":"account_is_in_progress","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account creation is in progress.","example":"Account creation is in progress.","description":"Human readable message."},"resolution":{"type":"string","title":"Please contact support.","example":"Please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_843"},"schema_844":{"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_844"},"schema_845":{"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_845"},"schema_846":{"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_846"},"schema_847":{"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_847"},"schema_848":{"kind":"json-schema","data":{"example":{"errorCode":"sender_already_deleted","message":"The sender has been deleted within the last 60 days.","resolution":"Wait the required time."},"title":"SenderAlreadyDeletedErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_already_deleted","example":"sender_already_deleted","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"The sender has been deleted within the last 60 days.","example":"The sender has been deleted within the last 60 days.","description":"Human readable message."},"resolution":{"type":"string","title":"Wait the required time.","example":"Wait the required time.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_848"},"schema_849":{"kind":"json-schema","data":{"oneOf":[{"title":"FileInvalidMimeTypeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_invalid_mime_type","example":"file_invalid_mime_type","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: invalid file mime type.","example":"details.logoImage: invalid file mime type.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with supported mime types: image/jpeg, image/png.","example":"Try again with supported mime types: image/jpeg, image/png.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["Description of fields failing validation"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoFieldsToUpdateErrorTitle","properties":{"errorCode":{"type":"string","title":"no_fields_to_update","example":"no_fields_to_update","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No fields to be updated.","example":"No fields to be updated.","description":"Human readable message."},"resolution":{"type":"string","title":"Supply at least one field to be updated.","example":"Supply at least one field to be updated.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderInvalidCategoryCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_invalid_category_code","example":"sender_invalid_category_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid sender category code(s).","example":"Invalid sender category code(s).","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the sender category code(s) used is supported.","example":"Verify that the sender category code(s) used is supported.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_849"},"schema_850":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_850"},"schema_851":{"kind":"json-schema","data":{"oneOf":[{"title":"FileNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"file_not_found","example":"file_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: file not found.","example":"details.logoImage: file not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the url is correct.","example":"Verify that the url is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileUnexpectedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"file_unexpected_error","example":"file_unexpected_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: file unexpected error.","example":"details.logoImage: file unexpected error.","description":"Human readable message."},"resolution":{"type":"string","title":"The file cannot be handled properly. Please try with another one.","example":"The file cannot be handled properly. Please try with another one.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileSizeTooLargeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_size_too_large","example":"file_size_too_large","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.logoImage: file size is too large.","example":"details.logoImage: file size is too large.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","example":"Try again with a smaller file. Max size for `image/jpeg` is 5MB.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderChangesNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_changes_not_updatable","example":"sender_changes_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender is not updatable.","example":"Sender is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by sender changes with status: DRAFT","example":"Updates are only supported by sender changes with status: DRAFT","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_updatable","example":"sender_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender is not updatable.","example":"Sender is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by senders with state: ACTIVE.","example":"Updates are only supported by senders with state: ACTIVE.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_851"},"schema_852":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_852"},"schema_853":{"kind":"json-schema","data":{"example":{"errorCode":"sender_changes_not_deletable","message":"Sender changes is not deletable.","resolution":"Only DRAFT, REJECTED senders changes can be marked for deletion."},"title":"SenderChangesNotDeletableErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_changes_not_deletable","example":"sender_changes_not_deletable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender changes is not deletable.","example":"Sender changes is not deletable.","description":"Human readable message."},"resolution":{"type":"string","title":"Only DRAFT, REJECTED senders changes can be marked for deletion.","example":"Only DRAFT, REJECTED senders changes can be marked for deletion.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_853"},"schema_854":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["details.buttons.0.name must be a string"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_854"},"schema_855":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidAppKeyErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_app_key","example":"invalid_app_key","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid app key.","example":"Invalid app key.","description":"Human readable message."},"resolution":{"type":"string","title":"Please check if the app key is correct","example":"Please check if the app key is correct","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_855"},"schema_856":{"kind":"json-schema","data":{"example":{"errorCode":"not_allowed_register","message":"Sender not allowed to be registered.","resolution":"Sender in \"ACTIVE\" state can't be registered."},"title":"NotAllowedRegisterErrorTitle","properties":{"errorCode":{"type":"string","title":"not_allowed_register","example":"not_allowed_register","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not allowed to be registered.","example":"Sender not allowed to be registered.","description":"Human readable message."},"resolution":{"type":"string","title":"Sender in \"ACTIVE\" state can't be registered.","example":"Sender in \"ACTIVE\" state can't be registered.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_856"},"schema_857":{"kind":"json-schema","data":{"example":{"errorCode":"not_allowed_verify","message":"Sender not allowed to be verified.","resolution":"Sender has to be in \"VERIFYING\" state to be verified."},"title":"NotAllowedVerifyErrorTitle","properties":{"errorCode":{"type":"string","title":"not_allowed_verify","example":"not_allowed_verify","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not allowed to be verified.","example":"Sender not allowed to be verified.","description":"Human readable message."},"resolution":{"type":"string","title":"Sender has to be in \"VERIFYING\" state to be verified.","example":"Sender has to be in \"VERIFYING\" state to be verified.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_857"},"schema_858":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateStatesEnum"}},"id":"schema_858"},"schema_859":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateStatusesEnum"}},"id":"schema_859"},"schema_860":{"kind":"json-schema","data":{"oneOf":[{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_found","example":"template_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template not found.","example":"Template not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_860"},"schema_861":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidCategoryCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_category_code","example":"template_invalid_category_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid template category code.","example":"Invalid template category code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the template category code used is supported for the provided project.","example":"Verify that the template category code used is supported for the provided project.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_861"},"schema_862":{"kind":"json-schema","data":{"example":{"errorCode":"template_exists","message":"Template already exists.","resolution":"Templates must have unique name. Change name and submit again."},"title":"TemplateExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"template_exists","example":"template_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template already exists.","example":"Template already exists.","description":"Human readable message."},"resolution":{"type":"string","title":"Templates must have unique name. Change name and submit again.","example":"Templates must have unique name. Change name and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_862"},"schema_863":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateKakaotalkValidationErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"template_kakaotalk_validation_error","example":"template_kakaotalk_validation_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template kakaoTalk validation error: Some details from provider","example":"Template kakaoTalk validation error: Some details from provider","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","description":"Additional information for error."}}},{"title":"TemplateKakaotalkValidationErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"template_kakaotalk_validation_error","example":"template_kakaotalk_validation_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template kakaoTalk validation error: Some details from provider","example":"Template kakaoTalk validation error: Some details from provider","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"templateCode":"AX5NnkwWABRXG7LjDBGa"},"description":"Additional information for error."}}}]},"id":"schema_863"},"schema_864":{"kind":"json-schema","data":{"oneOf":[{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","description":"Additional information for error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"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.","example":"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.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"templateCode":"templateCode"},"description":"Additional information for error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_864"},"schema_865":{"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_865"},"schema_866":{"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_866"},"schema_867":{"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_867"},"schema_868":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_found","example":"template_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template not found.","example":"Template not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_868"},"schema_869":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidCategoryCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_category_code","example":"template_invalid_category_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid template category code.","example":"Invalid template category code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the template category code used is supported for the provided project.","example":"Verify that the template category code used is supported for the provided project.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_869"},"schema_870":{"kind":"json-schema","data":{"oneOf":[{"title":"TemplateExistsErrorTitle","properties":{"errorCode":{"type":"string","title":"template_exists","example":"template_exists","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template already exists.","example":"Template already exists.","description":"Human readable message."},"resolution":{"type":"string","title":"Templates must have unique name. Change name and submit again.","example":"Templates must have unique name. Change name and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_updatable","example":"template_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template is not updatable.","example":"Template is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by templates with state: APPROVED, REJECTED.","example":"Updates are only supported by templates with state: APPROVED, REJECTED.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateChangesNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_changes_not_updatable","example":"template_changes_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template is not updatable.","example":"Template is not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Updates are only supported by template changes with status: DRAFT, REJECTED.","example":"Updates are only supported by template changes with status: DRAFT, REJECTED.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_870"},"schema_871":{"kind":"json-schema","data":{"example":{"errorCode":"template_not_deletable","message":"Template is not deletable.","resolution":"Only templates that has not yet been submitted to KakaoTalk is eligible for deletion."},"title":"TemplateNotDeletableErrorTitle","properties":{"errorCode":{"type":"string","title":"template_not_deletable","example":"template_not_deletable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Template is not deletable.","example":"Template is not deletable.","description":"Human readable message."},"resolution":{"type":"string","title":"Only templates that has not yet been submitted to KakaoTalk is eligible for deletion.","example":"Only templates that has not yet been submitted to KakaoTalk is eligible for deletion.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_871"},"schema_872":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["details.buttons.0.name must be a string"]},"description":"Additional information for error."}}},{"title":"ProjectNotInitializedErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_initialized","example":"project_not_initialized","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not initialized for KakaoTalk.","example":"Project not initialized for KakaoTalk.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","example":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"TemplateInvalidLanguageCodeErrorTitle","properties":{"errorCode":{"type":"string","title":"template_invalid_language_code","example":"template_invalid_language_code","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid language code.","example":"Invalid language code.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the language code used is supported by the Provisioning API and KakaoTalk.","example":"Verify that the language code used is supported by the Provisioning API and KakaoTalk.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"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"},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_872"},"schema_873":{"kind":"json-schema","data":{"example":{"errorCode":"conversation_app_id_invalid","message":"Conversation app id not valid.","resolution":"Verify the id is correct."},"title":"ConversationAppIdInvalidErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_id_invalid","example":"conversation_app_id_invalid","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app id not valid.","example":"Conversation app id not valid.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify the id is correct.","example":"Verify the id is correct.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_873"},"schema_874":{"kind":"json-schema","data":{"oneOf":[{"title":"ConversationAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_not_found","example":"conversation_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app not found.","example":"Conversation app not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ConversationAppNoInstagramChannelErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_no_instagram_channel","example":"conversation_app_no_instagram_channel","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app has no initialized Instagram channel.","example":"Conversation app has no initialized Instagram channel.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_874"},"schema_875":{"kind":"json-schema","data":{"oneOf":[{"title":"FacebookApiErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"facebook_api_error","example":"facebook_api_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Facebook API returned error.","example":"Facebook API returned error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again later.","example":"Please try again later.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_875"},"schema_876":{"kind":"json-schema","data":{"oneOf":[{"title":"ConversationAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_not_found","example":"conversation_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app not found.","example":"Conversation app not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ConversationAppNoMessengerChannelErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_no_messenger_channel","example":"conversation_app_no_messenger_channel","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app has no initialized Messenger channel.","example":"Conversation app has no initialized Messenger channel.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_876"},"schema_877":{"kind":"json-schema","data":{"oneOf":[{"title":"ConversationAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_not_found","example":"conversation_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app not found.","example":"Conversation app not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ConversationAppNoTelegramChannelErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_no_telegram_channel","example":"conversation_app_no_telegram_channel","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app has no initialized Telegram channel.","example":"Conversation app has no initialized Telegram channel.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_877"},"schema_878":{"kind":"json-schema","data":{"oneOf":[{"title":"TelegramApiErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"telegram_api_error","example":"telegram_api_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Telegram API returned error: 400, description: Bad Request: PHOTO_CROP_SIZE_SMALL.","example":"Telegram API returned error: 400, description: Bad Request: PHOTO_CROP_SIZE_SMALL.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again later.","example":"Please try again later.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_878"},"schema_879":{"kind":"json-schema","data":{"oneOf":[{"title":"ConversationAppNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_not_found","example":"conversation_app_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app not found.","example":"Conversation app not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"ConversationAppNoViberChannelErrorTitle","properties":{"errorCode":{"type":"string","title":"conversation_app_no_viber_channel","example":"conversation_app_no_viber_channel","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Conversation app has no initialized Viber channel.","example":"Conversation app has no initialized Viber channel.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_879"},"schema_880":{"kind":"json-schema","data":{"oneOf":[{"title":"ViberApiErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"viber_api_error","example":"viber_api_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Viber API returned error.","example":"Viber API returned error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please try again later.","example":"Please try again later.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InternalErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"internal_error","example":"internal_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Internal server error.","example":"Internal server error.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again, if the error persist please contact support.","example":"Please wait and try again, if the error persist please contact support.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_880"},"schema_881":{"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_881"},"schema_882":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsInputSenderUseCasesEnum"},"id":"schema_882"},"schema_883":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}},"id":"schema_883"},"schema_884":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsUsQuestionnaireVersionsEnum"},"id":"schema_884"},"schema_885":{"kind":"json-schema","data":{"oneOf":[{"title":"QuestionnaireInvalidUseCaseErrorTitle","properties":{"errorCode":{"type":"string","title":"questionnaire_invalid_use_case","example":"questionnaire_invalid_use_case","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid use case value.","example":"Invalid use case value.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the use case value is supported by the Provisioning API.","example":"Verify that the use case value is supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validUseCases":"MULTIUSE, OTP, PROMOTIONAL, TRANSACTIONAL"},"description":"Additional information for error."}}},{"title":"QuestionnaireInvalidCountryErrorTitle","properties":{"errorCode":{"type":"string","title":"questionnaire_invalid_country","example":"questionnaire_invalid_country","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid country.","example":"Invalid country.","description":"Human readable message."},"resolution":{"type":"string","title":"Use the supported values for the countries parameter.","example":"Use the supported values for the countries parameter.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedValues":"AT, BE, BR, CA, CZ, DK, FI, FR, DE, GR, HU, IT, MX, NL, NO, PE, PL, PT, SG, SK, ES, SE, US, GB"},"description":"Additional information for error."}}}]},"id":"schema_885"},"schema_886":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/RcsSenderStatesEnum"}},"id":"schema_886"},"schema_887":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsSenderSortColumnsEnum"},"id":"schema_887"},"schema_888":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsSortDirectionsEnum"},"id":"schema_888"},"schema_889":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidFilterStatesErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_filter_states","example":"invalid_filter_states","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid filterStates.","example":"Invalid filterStates.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the filterStates used are supported by the Provisioning API.","example":"Verify that the filterStates used are supported by the Provisioning API.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"supportedCodes":"DRAFT, IN_PROGRESS, IN_TEST, LAUNCHED, LAUNCHING, PREPARING_LAUNCH, UNLAUNCHED, UNKNOWN"},"description":"Additional information for error."}}}]},"id":"schema_889"},"schema_890":{"kind":"json-schema","data":{"example":{"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"},"title":"RbmHasNotBeenUsedErrorTitle","properties":{"errorCode":{"type":"string","title":"rbm_has_not_been_used","example":"rbm_has_not_been_used","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"RBM has not been used.","example":"RBM has not been used.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again or reach out to support at si-richmessaging@sinch.com","example":"Please wait and try again or reach out to support at si-richmessaging@sinch.com","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_890"},"schema_891":{"kind":"json-schema","data":{"example":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"title":"RbmTooManyRequestsErrorTitle","properties":{"errorCode":{"type":"string","title":"rbm_too_many_requests","example":"rbm_too_many_requests","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"RCS Business Messaging too many requests.","example":"RCS Business Messaging too many requests.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again.","example":"Please wait and try again.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_891"},"schema_892":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["details.brand.email.address must be an email"]},"description":"Additional information for error."}}},{"title":"FileInvalidMimeTypeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_invalid_mime_type","example":"file_invalid_mime_type","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.brand.bannerUrl: invalid file mime type.","example":"details.brand.bannerUrl: invalid file mime type.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with supported mime types: image/jpeg, image/png.","example":"Try again with supported mime types: image/jpeg, image/png.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidGoogleAgentErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_google_agent","example":"invalid_google_agent","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"message","example":"message","description":"Human readable message."},"resolution":{"type":"string","title":"Verify the sender's fields.","example":"Verify the sender's fields.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AddTestNumberInvalidErrorTitle","properties":{"errorCode":{"type":"string","title":"add_test_number_invalid","example":"add_test_number_invalid","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid phone number.","example":"Invalid phone number.","description":"Human readable message."},"resolution":{"type":"string","title":"Please verify that phone number is correct.","example":"Please verify that phone number is correct.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_892"},"schema_893":{"kind":"json-schema","data":{"oneOf":[{"title":"RbmHasNotBeenUsedErrorTitle","properties":{"errorCode":{"type":"string","title":"rbm_has_not_been_used","example":"rbm_has_not_been_used","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"RBM has not been used.","example":"RBM has not been used.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again or reach out to support at si-richmessaging@sinch.com","example":"Please wait and try again or reach out to support at si-richmessaging@sinch.com","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"RbmWebhookIncorrectSecretErrorTitle","properties":{"errorCode":{"type":"string","title":"rbm_webhook_incorrect_secret","example":"rbm_webhook_incorrect_secret","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"RBM webhook has incorrect secret","example":"RBM webhook has incorrect secret","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again or reach out to support at si-richmessaging@sinch.com","example":"Please wait and try again or reach out to support at si-richmessaging@sinch.com","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_893"},"schema_894":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"RbmResourcesNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"rbm_resources_not_found","example":"rbm_resources_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"RBM resources not found.","example":"RBM resources not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct, and contact support if error persists.","example":"Verify that the parameters are correct, and contact support if error persists.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_894"},"schema_895":{"kind":"json-schema","data":{"oneOf":[{"title":"AccountDataIsCorruptErrorTitle","properties":{"errorCode":{"type":"string","title":"account_data_is_corrupt","example":"account_data_is_corrupt","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Account data is corrupt.","example":"Account data is corrupt.","description":"Human readable message."},"resolution":{"type":"string","title":"Please contact support.","example":"Please contact support.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"file_not_found","example":"file_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.brand.logoUrl: file not found.","example":"details.brand.logoUrl: file not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the url is correct.","example":"Verify that the url is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileSizeTooLargeErrorTitle","properties":{"errorCode":{"type":"string","title":"file_size_too_large","example":"file_size_too_large","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.brand.bannerUrl: file size is too large.","example":"details.brand.bannerUrl: file size is too large.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with a smaller file. Max size for `image/jpeg` is 200KB.","example":"Try again with a smaller file. Max size for `image/jpeg` is 200KB.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileHasWrongDimensionsErrorTitle","properties":{"errorCode":{"type":"string","title":"file_has_wrong_dimensions","example":"file_has_wrong_dimensions","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.brand.logoUrl: image has wrong dimensions.","example":"details.brand.logoUrl: image has wrong dimensions.","description":"Human readable message."},"resolution":{"type":"string","title":"Try again with image dimensions: exact 224 x 224 px.","example":"Try again with image dimensions: exact 224 x 224 px.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FileUnexpectedErrorErrorTitle","properties":{"errorCode":{"type":"string","title":"file_unexpected_error","example":"file_unexpected_error","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"details.brand.logoUrl: file unexpected error.","example":"details.brand.logoUrl: file unexpected error.","description":"Human readable message."},"resolution":{"type":"string","title":"The file cannot be handled properly. Please try with another one.","example":"The file cannot be handled properly. Please try with another one.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_895"},"schema_896":{"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"]},"currentState":{"description":"The current state of the sender.","type":"string","enum":["DRAFT","IN_PROGRESS","IN_TEST","LAUNCHED","LAUNCHING","PREPARING_LAUNCH","UNLAUNCHED","UNKNOWN"]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","previousState","currentState"]},"id":"schema_896"},"schema_897":{"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","Cell C","Claro","Coriolis Telecom","Cosmote","Deutsche Telekom","Dialog Axiata PLC","Digi","DISH Wireless","DNA","Eastlink","EE","Elisa","Entel","Ethio Telecom","Fizz","Free","Freedom","Glo","Google Fi","Hrvatski Telecom","Hutchison 3G","Iliad","Indosat Ooredoo Hutchison","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","Sasktel","SFR","Simba","Singtel","Sky","Smart","Smartfren","Softbank","Spectrum","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"]},"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"]},"operatorPreviousStatus":{"description":"Previous country status.","type":"string","enum":["LAUNCHED","NOT_LAUNCHED","PENDING","PENDING_UNLAUNCHED","REJECTED","SUSPENDED","UNLAUNCHED","INVALID_IN_GOOGLE_MY_BUSINESS","UNRECOGNIZED"]},"operatorCurrentStatus":{"type":"string","description":"Country status.","enum":["LAUNCHED","NOT_LAUNCHED","PENDING","PENDING_UNLAUNCHED","REJECTED","SUSPENDED","UNLAUNCHED","INVALID_IN_GOOGLE_MY_BUSINESS","UNRECOGNIZED"]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","operator","operatorCountry","operatorPreviousStatus","operatorCurrentStatus"]},"id":"schema_897"},"schema_898":{"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_898"},"schema_899":{"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","COMPLETED","INCOMPLETE","NEW","PENDING","PENDING_REVIEW","REJECTED","UNRECOGNIZED","UNSPECIFIED"]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","status"]},"id":"schema_899"},"schema_900":{"kind":"json-schema","data":{"example":{"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."},"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_900"},"schema_901":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["details.brand.email.address must be an email"]},"description":"Additional information for error."}}},{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoFieldsToUpdateErrorTitle","properties":{"errorCode":{"type":"string","title":"no_fields_to_update","example":"no_fields_to_update","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No fields to be updated.","example":"No fields to be updated.","description":"Human readable message."},"resolution":{"type":"string","title":"Supply at least one field to be updated.","example":"Supply at least one field to be updated.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"FieldsNotUpdatableErrorTitle","properties":{"errorCode":{"type":"string","title":"fields_not_updatable","example":"fields_not_updatable","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Fields not updatable.","example":"Fields not updatable.","description":"Human readable message."},"resolution":{"type":"string","title":"Only `details.countries` and `details.launch` can be updated when in state:  LAUNCHING, LAUNCHED.","example":"Only `details.countries` and `details.launch` can be updated when in state:  LAUNCHING, LAUNCHED.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidGoogleAgentErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_google_agent","example":"invalid_google_agent","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"message","example":"message","description":"Human readable message."},"resolution":{"type":"string","title":"Verify the sender's fields.","example":"Verify the sender's fields.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AddTestNumberInvalidErrorTitle","properties":{"errorCode":{"type":"string","title":"add_test_number_invalid","example":"add_test_number_invalid","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid phone number.","example":"Invalid phone number.","description":"Human readable message."},"resolution":{"type":"string","title":"Please verify that phone number is correct.","example":"Please verify that phone number is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidRegionForAttSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_region_for_att_supplier","example":"invalid_region_for_att_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid region for ATT supplier.","example":"Invalid region for ATT supplier.","description":"Human readable message."},"resolution":{"type":"string","title":"ATT supplier is only allowed in the US region.","example":"ATT supplier is only allowed in the US region.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_901"},"schema_902":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"RbmResourcesNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"rbm_resources_not_found","example":"rbm_resources_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"RBM resources not found.","example":"RBM resources not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct, and contact support if error persists.","example":"Verify that the parameters are correct, and contact support if error persists.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"BlockedBecauseTheRecipientDeclinedErrorTitle","properties":{"errorCode":{"type":"string","title":"blocked_because_the_recipient_declined","example":"blocked_because_the_recipient_declined","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Blocked because the recipient declined.","example":"Blocked because the recipient declined.","description":"Human readable message."},"resolution":{"type":"string","title":"This operation is blocked because the recipient declined the invitation to become a tester.","example":"This operation is blocked because the recipient declined the invitation to become a tester.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_902"},"schema_903":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidPageTokenErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_token","example":"invalid_page_token","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid page token.","example":"Invalid page token.","description":"Human readable message."},"resolution":{"type":"string","title":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","example":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidPageSizeErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_page_size","example":"invalid_page_size","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Page size must be numeric.","example":"Page size must be numeric.","description":"Human readable message."},"resolution":{"type":"string","title":"Use a integer value for pageSize parameter.","example":"Use a integer value for pageSize parameter.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_903"},"schema_904":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["comment must be longer than or equal to 1 characters"]},"description":"Additional information for error."}}},{"title":"InvalidPayloadErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_payload","example":"invalid_payload","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid payload.","example":"Invalid payload.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct payload and submit again.","example":"Correct payload and submit again.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_904"},"schema_905":{"kind":"json-schema","data":{"oneOf":[{"title":"VerificationSuspendedInGmbErrorTitle","properties":{"errorCode":{"type":"string","title":"verification_suspended_in_gmb","example":"verification_suspended_in_gmb","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Associated Google My Business is suspended","example":"Associated Google My Business is suspended","description":"Human readable message."},"resolution":{"type":"string","title":"Reverify Google My Business.","example":"Reverify Google My Business.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidRegionForAttSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_region_for_att_supplier","example":"invalid_region_for_att_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid region for ATT supplier.","example":"Invalid region for ATT supplier.","description":"Human readable message."},"resolution":{"type":"string","title":"ATT supplier is only allowed in the US region.","example":"ATT supplier is only allowed in the US region.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_905"},"schema_906":{"kind":"json-schema","data":{"oneOf":[{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"RbmResourcesNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"rbm_resources_not_found","example":"rbm_resources_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"RBM resources not found.","example":"RBM resources not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct, and contact support if error persists.","example":"Verify that the parameters are correct, and contact support if error persists.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_906"},"schema_907":{"kind":"json-schema","data":{"oneOf":[{"title":"LaunchInvalidAgentStateErrorTitle","properties":{"errorCode":{"type":"string","title":"launch_invalid_agent_state","example":"launch_invalid_agent_state","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender can't be launched.","example":"Sender can't be launched.","description":"Human readable message."},"resolution":{"type":"string","title":"Launch are only supported by senders with state: IN_TEST, LAUNCHING, LAUNCHED, UNLAUNCHED.","example":"Launch are only supported by senders with state: IN_TEST, LAUNCHING, LAUNCHED, UNLAUNCHED.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"LaunchInvalidVerificationStateErrorTitle","properties":{"errorCode":{"type":"string","title":"launch_invalid_verification_state","example":"launch_invalid_verification_state","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender verification can't be updated.","example":"Sender verification can't be updated.","description":"Human readable message."},"resolution":{"type":"string","title":"Sender verification update are only supported by verifications with state: VERIFICATION_STATE_PENDING.","example":"Sender verification update are only supported by verifications with state: VERIFICATION_STATE_PENDING.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_907"},"schema_908":{"kind":"json-schema","data":{"example":{"errorCode":"launch_precondition_failed","message":"Launch precondition failed.","resolution":"Correct the precondition errors and launch again.","additionalInformation":{"validationErrors":["validation.error"]}},"title":"LaunchPreconditionFailedErrorTitle","properties":{"errorCode":{"type":"string","title":"launch_precondition_failed","example":"launch_precondition_failed","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Launch precondition failed.","example":"Launch precondition failed.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the precondition errors and launch again.","example":"Correct the precondition errors and launch again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["validation.error"]},"description":"Additional information for error."}}},"id":"schema_908"},"schema_909":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidInputErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_input","example":"invalid_input","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid input.","example":"Invalid input.","description":"Human readable message."},"resolution":{"type":"string","title":"Correct the validation errors and submit again.","example":"Correct the validation errors and submit again.","description":"Human readable message with an explanation of how to solve the error."},"additionalInformation":{"type":"object","title":"additionalInformation","example":{"validationErrors":["each value in testNumbers must be a string"]},"description":"Additional information for error."}}},{"title":"NoGoogleSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"no_google_supplier","example":"no_google_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No google supplier in sender.","example":"No google supplier in sender.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the sender has google supplier.","example":"Verify that the sender has google supplier.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AddTestNumberInvalidErrorTitle","properties":{"errorCode":{"type":"string","title":"add_test_number_invalid","example":"add_test_number_invalid","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid phone number.","example":"Invalid phone number.","description":"Human readable message."},"resolution":{"type":"string","title":"Please verify that phone number is correct.","example":"Please verify that phone number is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidRegionForAttSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_region_for_att_supplier","example":"invalid_region_for_att_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid region for ATT supplier.","example":"Invalid region for ATT supplier.","description":"Human readable message."},"resolution":{"type":"string","title":"ATT supplier is only allowed in the US region.","example":"ATT supplier is only allowed in the US region.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_909"},"schema_910":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AddTestNumberNotAllowedBeforeLaunchErrorTitle","properties":{"errorCode":{"type":"string","title":"add_test_number_not_allowed_before_launch","example":"add_test_number_not_allowed_before_launch","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Adding test number not allowed before launch.","example":"Adding test number not allowed before launch.","description":"Human readable message."},"resolution":{"type":"string","title":"Carrier does not allow test number to be created prior to sender launch.","example":"Carrier does not allow test number to be created prior to sender launch.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"BlockedBecauseTheRecipientDeclinedErrorTitle","properties":{"errorCode":{"type":"string","title":"blocked_because_the_recipient_declined","example":"blocked_because_the_recipient_declined","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Blocked because the recipient declined.","example":"Blocked because the recipient declined.","description":"Human readable message."},"resolution":{"type":"string","title":"This operation is blocked because the recipient declined the invitation to become a tester.","example":"This operation is blocked because the recipient declined the invitation to become a tester.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UserCannotBeReachedErrorTitle","properties":{"errorCode":{"type":"string","title":"user_cannot_be_reached","example":"user_cannot_be_reached","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"message","example":"message","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the user has RCS feature available.","example":"Verify that the user has RCS feature available.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_910"},"schema_911":{"kind":"json-schema","data":{"example":{"errorCode":"no_google_supplier","message":"No google supplier in sender.","resolution":"Verify that the sender has google supplier."},"title":"NoGoogleSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"no_google_supplier","example":"no_google_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No google supplier in sender.","example":"No google supplier in sender.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the sender has google supplier.","example":"Verify that the sender has google supplier.","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_911"},"schema_912":{"kind":"json-schema","data":{"oneOf":[{"title":"ProjectNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"project_not_found","example":"project_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Project not found.","example":"Project not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the projectId is correct.","example":"Verify that the projectId is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UserIsNotTesterForAgentErrorTitle","properties":{"errorCode":{"type":"string","title":"user_is_not_tester_for_agent","example":"user_is_not_tester_for_agent","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Test number not found.","example":"Test number not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Add test number to agent.","example":"Add test number to agent.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_912"},"schema_913":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoGoogleSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"no_google_supplier","example":"no_google_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No google supplier in sender.","example":"No google supplier in sender.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the sender has google supplier.","example":"Verify that the sender has google supplier.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidRegionForAttSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_region_for_att_supplier","example":"invalid_region_for_att_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid region for ATT supplier.","example":"Invalid region for ATT supplier.","description":"Human readable message."},"resolution":{"type":"string","title":"ATT supplier is only allowed in the US region.","example":"ATT supplier is only allowed in the US region.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_913"},"schema_914":{"kind":"json-schema","data":{"oneOf":[{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UserIsNotTesterForAgentErrorTitle","properties":{"errorCode":{"type":"string","title":"user_is_not_tester_for_agent","example":"user_is_not_tester_for_agent","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Test number not found.","example":"Test number not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Add test number to agent.","example":"Add test number to agent.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_914"},"schema_915":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoGoogleSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"no_google_supplier","example":"no_google_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No google supplier in sender.","example":"No google supplier in sender.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the sender has google supplier.","example":"Verify that the sender has google supplier.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_915"},"schema_916":{"kind":"json-schema","data":{"example":{"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"},"title":"WrongSupplierConfigurationErrorTitle","properties":{"errorCode":{"type":"string","title":"wrong_supplier_configuration","example":"wrong_supplier_configuration","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Wrong supplier configuration is used, configuration needs to be setup via SI team","example":"Wrong supplier configuration is used, configuration needs to be setup via SI team","description":"Human readable message."},"resolution":{"type":"string","title":"Please reach out to support at si-richmessaging@sinch.com","example":"Please reach out to support at si-richmessaging@sinch.com","description":"Human readable message with an explanation of how to solve the error."}}},"id":"schema_916"},"schema_917":{"kind":"json-schema","data":{"oneOf":[{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UserIsNotTesterForAgentErrorTitle","properties":{"errorCode":{"type":"string","title":"user_is_not_tester_for_agent","example":"user_is_not_tester_for_agent","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Test number not found.","example":"Test number not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Add test number to agent.","example":"Add test number to agent.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"LookingUpTheRbmAgentErrorTitle","properties":{"errorCode":{"type":"string","title":"looking_up_the_rbm_agent","example":"looking_up_the_rbm_agent","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Looking up the RBM agent.","example":"Looking up the RBM agent.","description":"Human readable message."},"resolution":{"type":"string","title":"There was an error looking up the RBM agent.","example":"There was an error looking up the RBM agent.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"BlockedBecauseTheRecipientDeclinedErrorTitle","properties":{"errorCode":{"type":"string","title":"blocked_because_the_recipient_declined","example":"blocked_because_the_recipient_declined","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Blocked because the recipient declined.","example":"Blocked because the recipient declined.","description":"Human readable message."},"resolution":{"type":"string","title":"This operation is blocked because the recipient declined the invitation to become a tester.","example":"This operation is blocked because the recipient declined the invitation to become a tester.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UserHasNotAcceptedInviteErrorTitle","properties":{"errorCode":{"type":"string","title":"user_has_not_accepted_invite","example":"user_has_not_accepted_invite","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"User has not accepted invite to become tester for agent.","example":"User has not accepted invite to become tester for agent.","description":"Human readable message."},"resolution":{"type":"string","title":"Please wait and try again later.","example":"Please wait and try again later.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UserCannotBeReachedErrorTitle","properties":{"errorCode":{"type":"string","title":"user_cannot_be_reached","example":"user_cannot_be_reached","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"message","example":"message","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the user has RCS feature available.","example":"Verify that the user has RCS feature available.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_917"},"schema_918":{"kind":"json-schema","data":{"oneOf":[{"title":"InvalidIdFormatErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_id_format","example":"invalid_id_format","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Id is not in the expected format.","example":"Id is not in the expected format.","description":"Human readable message."},"resolution":{"type":"string","title":"senderId param is in the wrong format. Confirm that you're sending the correct value.","example":"senderId param is in the wrong format. Confirm that you're sending the correct value.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"NoGoogleSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"no_google_supplier","example":"no_google_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"No google supplier in sender.","example":"No google supplier in sender.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the sender has google supplier.","example":"Verify that the sender has google supplier.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AddTestNumberInvalidErrorTitle","properties":{"errorCode":{"type":"string","title":"add_test_number_invalid","example":"add_test_number_invalid","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid phone number.","example":"Invalid phone number.","description":"Human readable message."},"resolution":{"type":"string","title":"Please verify that phone number is correct.","example":"Please verify that phone number is correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"InvalidRegionForAttSupplierErrorTitle","properties":{"errorCode":{"type":"string","title":"invalid_region_for_att_supplier","example":"invalid_region_for_att_supplier","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Invalid region for ATT supplier.","example":"Invalid region for ATT supplier.","description":"Human readable message."},"resolution":{"type":"string","title":"ATT supplier is only allowed in the US region.","example":"ATT supplier is only allowed in the US region.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_918"},"schema_919":{"kind":"json-schema","data":{"oneOf":[{"title":"SenderNotFoundErrorTitle","properties":{"errorCode":{"type":"string","title":"sender_not_found","example":"sender_not_found","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Sender not found.","example":"Sender not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Verify that the parameters are correct.","example":"Verify that the parameters are correct.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"UserIsNotTesterForAgentErrorTitle","properties":{"errorCode":{"type":"string","title":"user_is_not_tester_for_agent","example":"user_is_not_tester_for_agent","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Test number not found.","example":"Test number not found.","description":"Human readable message."},"resolution":{"type":"string","title":"Add test number to agent.","example":"Add test number to agent.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"AddTestNumberNotAllowedBeforeLaunchErrorTitle","properties":{"errorCode":{"type":"string","title":"add_test_number_not_allowed_before_launch","example":"add_test_number_not_allowed_before_launch","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Adding test number not allowed before launch.","example":"Adding test number not allowed before launch.","description":"Human readable message."},"resolution":{"type":"string","title":"Carrier does not allow test number to be created prior to sender launch.","example":"Carrier does not allow test number to be created prior to sender launch.","description":"Human readable message with an explanation of how to solve the error."}}},{"title":"BlockedBecauseTheRecipientDeclinedErrorTitle","properties":{"errorCode":{"type":"string","title":"blocked_because_the_recipient_declined","example":"blocked_because_the_recipient_declined","description":"Error code allows to programmatically handle errors."},"message":{"type":"string","title":"Blocked because the recipient declined.","example":"Blocked because the recipient declined.","description":"Human readable message."},"resolution":{"type":"string","title":"This operation is blocked because the recipient declined the invitation to become a tester.","example":"This operation is blocked because the recipient declined the invitation to become a tester.","description":"Human readable message with an explanation of how to solve the error."}}}]},"id":"schema_919"}},"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/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~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}/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}/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}~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"},"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/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"}},"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"},"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/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"},"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"},"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"}},"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"}},"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"},"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"},"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/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"},"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~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~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~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~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~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~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~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"},"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"}},"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/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"}},"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/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"},"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"},"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"},"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"},"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"}},"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"},"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"},"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"},"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/UsernameUpdate/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"},"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/UsernameUpdate/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"},"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}/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"},"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/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"},"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"},"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"},"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"},"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"}},"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"},"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"},"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"},"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/UsernameUpdate/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"},"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/UsernameUpdate/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}~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}~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}~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~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/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~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~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!","example":"20"},{"type":"HEADER","format":"DOCUMENT","example":{"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}}","example":"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":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","example":{"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}}","example":"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/marketingOrUtilityMinimum":{"value":{"name":"my_template","category":"UTILITY","language":"EN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","example":"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!","example":"20"},{"type":"HEADER","format":"DOCUMENT","example":{"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}}","example":"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":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","example":{"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}}","example":"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}},"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/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!","example":"20"},{"type":"HEADER","format":"DOCUMENT","example":{"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}}","example":"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":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","example":{"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}}","example":"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}},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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}~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!","example":"20"},{"type":"HEADER","format":"DOCUMENT","example":{"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}}","example":"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":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","example":{"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}}","example":"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/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!","example":"20"},{"type":"HEADER","format":"DOCUMENT","example":{"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}}","example":"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":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","example":{"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}}","example":"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}},"details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","example":"20"}],"messageSendTtlSeconds":60},"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/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!","example":"20"},{"type":"HEADER","format":"DOCUMENT","example":{"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}}","example":"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":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","example":{"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}}","example":"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}},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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!","example":"20"}],"messageSendTtlSeconds":60},"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}~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}~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}~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/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/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}~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~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~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/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/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}/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}~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}~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}~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}~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}~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/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/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}/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}~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}~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}~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}~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}~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~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/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/newResponse":{"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":[]}}}},"key":"newResponse","summary":"Get 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/newResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/response":{"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":[]}}}},"key":"response","summary":"[Deprecated] Get 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/response"},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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/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"}},"us":{"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","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"}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","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"}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","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"}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","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"}},"us":{"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","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"}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","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"}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","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"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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/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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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}/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"}},"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","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"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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}~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}~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}~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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]},"companyPhoneNumber":{"question":"What is the primary phone number 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","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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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":[]}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777"}},"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}~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~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}~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}~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"}},"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-1","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-1","routesMapping":{}}