# Provisioning API Version: 1.2.7 ## Servers Production server ``` https://provisioning.api.sinch.com ``` ## Security ### BasicAuth Type: http Scheme: basic ### BearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Provisioning API](https://developers.sinch.com/_spec/docs/provisioning-api/api-reference/provisioning-api.yaml) ## Webhooks Webhooks allow the Sinch servers to communicate with your server backend. The `webhooks` endpoint lets you create, update, and delete webhooks programmatically. ### List all webhooks in project - [GET /v1/projects/{projectId}/webhooks](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookcontroller_listwebhooks_v1.md): Returns a paginated list of webhooks for the specified project. If no page token is supplied then all registered webhooks (of maximum ) are returned in alphabetical order. ### Register a webhook for project - [POST /v1/projects/{projectId}/webhooks](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookcontroller_createwebhook_v1.md): Register a new webhook for a project. The webhook will be used to communicate updates to resources. Maximum of webhooks allowed per project. ### Get webhook - [GET /v1/projects/{projectId}/webhooks/{webhookId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookcontroller_getwebhook_v1.md): Return an already created webhook. ### Delete webhook - [DELETE /v1/projects/{projectId}/webhooks/{webhookId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookcontroller_deletewebhook_v1.md): Deletes an already created webhook. ### Replace webhook - [PUT /v1/projects/{projectId}/webhooks/{webhookId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookcontroller_replacewebhook_v1.md): Replace an already existing webhook. ### Update webhook - [PATCH /v1/projects/{projectId}/webhooks/{webhookId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookcontroller_updatewebhook_v1.md): Update an already existing webhook. ## Bundles The bundles endpoint allows you to create and manage bundles of account resources. ### Create bundle for project - [POST /v1/projects/{projectId}/bundles](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlescontroller_create_v1.md): Creates a new bundle of resources based on the input work order. ### Get bundle by projectId and bundleId - [GET /v1/projects/{projectId}/bundles/{bundleId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlescontroller_get_v1.md): Retrieve created bundle and resources created. ## Conversation The Conversation endpoints allows you to retrieve about channels used with Conversation API. ### Get Instagram channel information - [GET /v1/projects/{projectId}/conversation/apps/{conversationAppId}/instagram](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/conversation/instagramcontroller_get_v1.md): Returns the information for an Instagram channel linked to a Conversation API App. ### Get Facebook Messenger channel information - [GET /v1/projects/{projectId}/conversation/apps/{conversationAppId}/messenger](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/conversation/messengercontroller_get_v1.md): Returns the information for a Facebook Messenger channel linked to a Conversation API App. ### Get Telegram Bot channel information - [GET /v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/conversation/telegramcontroller_get_v1.md): Returns the information for a Telegram Bot channel linked to a Conversation API App. ### Get Viber Bot channel information - [GET /v1/projects/{projectId}/conversation/apps/{conversationAppId}/viber](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/conversation/vibercontroller_get_v1.md): Returns the information for a Viber Bot channel linked to a Conversation API App. ## WhatsApp The WhatsApp endpoint allows you to programmatically log in to and get details of your WhatsApp account. ### Enable Meta template analytics - [PUT /v1/projects/{projectId}/whatsapp/enableTemplateAnalytics](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp/templateanalyticshelperscontroller_enabletemplateanalytics_v1.md): Enable Meta template analytics for WhatsApp Business Account. ### Create a long lived access token (deprecated) - [POST /v1/projects/{projectId}/whatsapp/longLivedAccessToken](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp/embeddedsignuphelpercontroller_createlonglivedaccesstoken_v1.md): Returns a long lived access token based on the facebook token from the embedded signup. Valid for 60 days. ### List WhatsApp Business Accounts details (deprecated) - [POST /v1/projects/{projectId}/whatsapp/wabaDetails](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp/embeddedsignuphelpercontroller_listwabadetailsfortoken_v1.md): Returns a list of all the WhatsApp Business Accounts that the facebook token is associated with, together with the numbers that are shared. ## WhatsApp Templates 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. ### List all templates in project - [GET /v1/projects/{projectId}/whatsapp/templates](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_listtemplates_v1.md): Returns a paginated list of templates for the specified project. If no page token is supplied then the first templates are returned in alphabetical order. ### Create a template in project - [POST /v1/projects/{projectId}/whatsapp/templates](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_createtemplate_v1.md): Creates a new template with the request data. If the field is set to the template will be created immediately, otherwise it will be saved as a . ### List all templates for a specific name - [GET /v1/projects/{projectId}/whatsapp/templates/{templateName}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_listtemplatesbyname_v1.md): Returns a paginated list of templates for the specified project and name. If no page token is supplied then the first templates are returned in alphabetical order. ### Delete template by name - [DELETE /v1/projects/{projectId}/whatsapp/templates/{templateName}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_deletetemplatesbyname_v1.md): Delete template that matches the name. If message templates with the same name exists in multiple languages, all those templates will also be deleted. 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. 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. ### Get template in project - [GET /v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_gettemplate_v1.md): Returns a template for a project, with the specified name and language. ### Delete template by name and language - [DELETE /v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_deletetemplatebynameandlanguage_v1.md): Delete a template by name and language. Please note that by default only draft is removed. Use query parameter to also remove the submitted template. 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. 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. ### Update a template in project - [PATCH /v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_updatetemplate_v1.md): Updates a template DRAFT. Note that it is not possible to update all fields for a template, if you want to update a field that is not supported you will need to delete the draft and create a new one. Update a template REJECTED / APPROVED / PAUSED / DISABLED 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. ### Lists activities on project template - [GET /v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/activities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_listactivities_v1.md): Paginated list of activities for a template. Ordered from the most recent one to the oldest one. ### Creates a comment for a template - [POST /v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/comments](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_createcomment_v1.md): Creates a comment for a template. ### Compare two templates - [POST /v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/compare](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/templatescontroller_comparetemplates_v1.md): Compare two templates. ## WhatsApp Senders 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. ### List all senders in project - [GET /v1/projects/{projectId}/whatsapp/senders](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_listsenders_v1.md): Returns a paginated list of senders for the specified project. If no page token is supplied then the first will be returned. ### Create sender for project - [POST /v1/projects/{projectId}/whatsapp/senders](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_createsender_v1.md): Creates a sender for a project. The possible combinations of region, business manager and hosting type are the following | Region | | SINCH_BR | SINCH_MX | SINCH_UK | | --------- | -- | --- | --- | --- | | BR | Cloud API (ES) | ✅ Supported | ✅ Supported | ❌ Unsupported | | | Cloud API ( OBO ) | ✅ Supported | ✅ Supported | ❌ Unsupported | | EU | Cloud API (ES) | ❌ Unsupported | ❌ Unsupported | ✅ Supported | | | Cloud API ( OBO ) | ❌ Unsupported | ❌ Unsupported | ✅ Supported | | US | Cloud API (ES) | ✅ Supported | ✅ Supported | ✅ Supported | | | Cloud API ( OBO ) | ✅ Supported | ✅ Supported | ✅ Supported | ### Get sender for project - [GET /v1/projects/{projectId}/whatsapp/senders/{senderId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_get_v1.md): Returns a sender for a project. ### Delete sender for project - [DELETE /v1/projects/{projectId}/whatsapp/senders/{senderId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_delete_v1.md): 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. ### Updates a sender in project - [PATCH /v1/projects/{projectId}/whatsapp/senders/{senderId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_update_v1.md): Updates a sender in project. ### Lists activities on sender - [GET /v1/projects/{projectId}/whatsapp/senders/{senderId}/activities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_listactivities_v1.md): Paginated list of activities for sender. Ordered from the most recent one to the oldest one. ### Delete pending or rejected changes to a sender - [DELETE /v1/projects/{projectId}/whatsapp/senders/{senderId}/changes](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_deletechanges_v1.md): Delete pending or rejected changes to a sender. ### Creates a comment for a sender in project - [POST /v1/projects/{projectId}/whatsapp/senders/{senderId}/comments](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_createcomment_v1.md): Creates a comment for a sender in project. ### Register sender for project - [POST /v1/projects/{projectId}/whatsapp/senders/{senderId}/register](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_register_v1.md): 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. ### Verify sender for project - [POST /v1/projects/{projectId}/whatsapp/senders/{senderId}/verify](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/senderscontroller_verify_v1.md): Verify sender with the OTP received after triggering registration. ## WhatsApp Accounts The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments. ### Get account for project - [GET /v1/projects/{projectId}/whatsapp](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/accountscontroller_getaccount_v1.md): Returns an account for a project. ### Create account for project - [POST /v1/projects/{projectId}/whatsapp](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/accountscontroller_createaccount_v1.md): Create the WhatsApp account for the project. Each project can only have one account. ### Update account for project - [PATCH /v1/projects/{projectId}/whatsapp](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/accountscontroller_updateaccount_v1.md): Update an account. It is only possible to update an account that has been rejected. After update the status will be set to . ### Lists activities on account - [GET /v1/projects/{projectId}/whatsapp/activities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/accountscontroller_listactivities_v1.md): Lists activities on account from the most recent one to the oldest one. ### Creates a comment for an account - [POST /v1/projects/{projectId}/whatsapp/comments](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/accountscontroller_createcomment_v1.md): Creates a comment for an account. ## WhatsApp Flows The WhatsApp flows endpoint lets you retrieve and manage WhatsApp Flows associated with the project. ### Get flows in the WhatsApp business account (WABA) associated to the project - [GET /v1/projects/{projectId}/whatsapp/flows](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows/flowscontroller_listflows_v1.md): Retrieve the list of flows created in the WhatsApp business account (WABA) associated with the project. ### Get screens of a flow - [GET /v1/projects/{projectId}/whatsapp/flows/{flowId}/screens](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows/flowscontroller_listflowscreens_v1.md): Retrieve the list of screens in a flow. ## WhatsApp Solutions The WhatsApp solutions endpoint offers a way for you to manage your WhatsApp solutions. ### List all solutions in project - [GET /v1/projects/{projectId}/whatsapp/solutions](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/solutionscontroller_listsolutions_v1.md): Returns a list of solutions for the specified project. ### Create solution for project - [POST /v1/projects/{projectId}/whatsapp/solutions](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/solutionscontroller_createsolution_v1.md): Returns all solutions for a project. ### Get solution for project - [GET /v1/projects/{projectId}/whatsapp/solutions/{solutionId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/solutionscontroller_getsolution_v1.md): Returns a solution for a project. ### Assign solution to project - [POST /v1/projects/{projectId}/whatsapp/solutions/{solutionId}/assign](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/solutionscontroller_assignsolution_v1.md): Assign solution to project, to enable Embedded Signup onboarding. ## KakaoTalk Templates The KakaoTalk template endpoint offers a way for you to manage your KakaoTalk templates that can be used with the Conversation API. ### List all templates in project - [GET /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_listtemplates_v1.md): Returns a paginated list of templates for the specified project. If no page token is supplied then the first templates are returned in alphabetical order. ### Create a template in project - [POST /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_createtemplate_v1.md): Creates a new template with the request data. ### Get template in project - [GET /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/templatescontroller_get_v1.md): Returns a template for a project, with the specified name and language. ### Delete template for project - [DELETE /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/templatescontroller_deletetemplate_v1.md): Delete template that matches the template code. ### Update a template in project - [PATCH /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_updatetemplate_v1.md): Updates an existing template with the request data. ### Lists activities on project template - [GET /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/activities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_listactivities_v1.md): Paginated list of activities for a template. Ordered from the most recent one to the oldest one. ### Delete template draft for project - [DELETE /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/changes](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/templatescontroller_deletetemplatedraft_v1.md): Delete a template draft. Please note that it is only possible to delete templates that have not yet been submitted to KakaoTalk. ### Creates a comment for a template - [POST /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/comments](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_createcomment_v1.md): Creates a comment for a template. ## KakaoTalk Categories The KakoaTalk categories endpoint offers a way for you to manage all of the KakaoTalk template categories that you can use with the Conversation API. ### List all sender categories. - [GET /v1/projects/{projectId}/kakaotalk/categories/senders](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories/categoriescontroller_listsendercategories_v1.md): Returns a list of sender categories. ### List all template categories in project - [GET /v1/projects/{projectId}/kakaotalk/categories/senders/{plusFriendId}/templates](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories/categoriescontroller_gettemplatecategories_v1.md): Returns a list of template categories for the specified project. ## KakaoTalk Senders The KakaoTalk sender endpoint offers a way for you to manage your KakaoTalk senders that can be used with the Conversation API. ### List all senders in project - [GET /v1/projects/{projectId}/kakaotalk/senders](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_listsenders_v1.md): Returns a paginated list of senders for the specified project. If no page token is supplied then the first will be returned. ### Create sender for project - [POST /v1/projects/{projectId}/kakaotalk/senders](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_createsender_v1.md): Creates a sender for a project. ### Get sender for project - [GET /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/senderscontroller_getsender_v1.md): Returns a sender for a project. ### Delete sender for project - [DELETE /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/senderscontroller_deletesender_v1.md): 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. ### Updates a draft sender in project - [PATCH /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/senderscontroller_updatesender_v1.md): Updates a draft sender in project. ### Lists activities on sender - [GET /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/activities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_listactivities_v1.md): Paginated list of activities for sender. Ordered from the most recent one to the oldest one. ### Delete pending or rejected changes to a sender - [DELETE /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/changes](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_deletechanges_v1.md): Delete pending or rejected changes to a sender. ### Creates a comment for a sender in project - [POST /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/comments](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_createcomment_v1.md): Creates a comment for a sender. ### Register sender for project - [POST /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/register](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/senderscontroller_registersender_v1.md): Requests sender registration for a project. ### Verify sender for project - [POST /v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/verify](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/senderscontroller_verifysender_v1.md): Verifies sender with the OTP code received after triggering registration. ## RCS Accounts The RCS endpoint offers you a way to manage your RCS accounts. ### Lists activities on account - [GET /v1/projects/{projectId}/rcs/activities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts/rcsaccountscontroller_listactivities_v1.md): Paginated list of activities for account. Ordered from the most recent one to the oldest one. ### Creates a comment for an account - [POST /v1/projects/{projectId}/rcs/comments](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts/rcsaccountscontroller_createcomment_v1.md): Creates a comment for an account. ## RCS Questionnaire Manage your RCS questionnaires. ### Get questionnaire questions for project and use case - [GET /v1/projects/{projectId}/rcs/questionnaire/{useCase}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-questionnaire/questionnairecontroller_getquestions_v1.md): Returns questionnaire questions for a use case. The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change. ## RCS Senders The RCS sender endpoint offers a way for you to manage your RCS senders that can be used with the Conversation API. ### List all senders in project - [GET /v1/projects/{projectId}/rcs/senders](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_listsenders_v1.md): Returns a paginated list of senders for the specified project. If no page token is supplied then the first will be returned. ### Create sender for project - [POST /v1/projects/{projectId}/rcs/senders](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_createsender_v1.md): Returns a sender for a project. ### Get sender for project - [GET /v1/projects/{projectId}/rcs/senders/{senderId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_getsender_v1.md): Returns a sender for a project. ### Update sender for project - [PATCH /v1/projects/{projectId}/rcs/senders/{senderId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_updatesender_v1.md): Returns updated sender for a project. ### Lists activities on sender - [GET /v1/projects/{projectId}/rcs/senders/{senderId}/activities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_listactivities_v1.md): Paginated list of activities for sender. Ordered from the most recent one to the oldest one. ### Creates a comment for a sender in project - [POST /v1/projects/{projectId}/rcs/senders/{senderId}/comments](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/senderscontroller_createsendercomment_v1.md): Creates a comment for a sender in project. ### Begin launch process for sender - [POST /v1/projects/{projectId}/rcs/senders/{senderId}/launch](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/senderscontroller_launchsender_v1.md): Begins launch process for a sender in project. Requirements to begin launch process: - Questionnaire needs to be completed; - Countries () must have at least one (1) value; - At least one contact phone number () or a contact email () is required, but both are recommended; - A brand banner url () must be defined; - A brand logo url () must be defined; - A privacy policy url () must be defined; - A terms of service url () must be defined; If no video URI was provided in questionnaire, Sender will go into PENDING_LAUNCH while a video is added by Service Implementation. ### Add test numbers to sender for project - [POST /v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/senderscontroller_addtestnumbers_v1.md): Returns updated test number states of sender for a project. 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. ### Deletes test number for the sender - [DELETE /v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/senderscontroller_deletetestnumber_v1.md): Deletes test number for the sender. Please note that this method is only able to delete test number for the sender in Sinch database, in order to delete it from Google agent you need to use Google console. ### Get test number capabilities of sender for project - [GET /v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/capabilities](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/senderscontroller_gettestnumbercapabilities_v1.md): Returns test number capabilities of sender for a project. ### Resend an invite to test number of sender for project - [GET /v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/retry](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/senderscontroller_retrytestnumber_v1.md): Resend an invite and returns state for test number of sender for a project. ## RCS Upscales The RCS upscales endpoint offers a way for you to manage your RCS upscales. ### List all upscales - [GET /v1/projects/{projectId}/rcs/upscales](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-upscales/upscalescontroller_listupscales_v1.md): Returns a paginated list of all upscales. If no page token is supplied then the first will be returned. ### Create upscale - [POST /v1/projects/{projectId}/rcs/upscales](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-upscales/upscalescontroller_createupscale_v1.md): Returns a upscale. ### Get upscale - [GET /v1/projects/{projectId}/rcs/upscales/{upscaleId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-upscales/upscalescontroller_getupscale_v1.md): Returns a upscale. ### Delete upscale - [DELETE /v1/projects/{projectId}/rcs/upscales/{upscaleId}](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-upscales/upscalescontroller_deleteupscale_v1.md): Delete upscale. ### Retry upscale - [POST /v1/projects/{projectId}/rcs/upscales/{upscaleId}/retry](https://developers.sinch.com/docs/provisioning-api/api-reference/provisioning-api/rcs-upscales/upscalescontroller_retryupscale_v1.md): Retry upscale.