--- title: Instant Messaging Delivery Settings description: Use the /instantMessagingDeliverySettings/whatsApp endpoint to configure the sending of PingOne notifications via WhatsApp. component: pingone-api page_id: pingone-api:platform:notifications/instant-messaging-delivery-settings canonical_url: https://developer.pingidentity.com/pingone-api/platform/notifications/instant-messaging-delivery-settings.html section_ids: whatsapp-delivery-settings-data-model: WhatsApp delivery settings data model --- # Instant Messaging Delivery Settings Use the `/instantMessagingDeliverySettings/whatsApp` endpoint to configure the sending of PingOne notifications via WhatsApp. []() ## WhatsApp delivery settings data model | Property | Type | Required? | Mutable? | Description | | --------------------------- | ------- | --------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `appId` | String | Required | Mutable | The ID of the WhatsApp app you are using for sending the notifications. | | `appSecret` | String | Required | Mutable | The secret for the WhatsApp app you are using for sending the notifications. | | `createdAt` | Date | N/A | Read-only | Date and time that the delivery settings were created. | | `environment.id` | String | N/A | Read-only | The ID of the PingOne environment. | | `id` | String | N/A | Read-only | The ID assigned to the delivery settings. | | `numbers[]` | Array | Optional | Mutable | The `numbers` array is included in the response when creating WhatsApp settings. It contains information about the various phone numbers available for use with the app ID that was specified in the creation request. If there is more than one number available for the app, a second PUT request can be run to specify the number to use for sending notifications. To specify the number to use, include the `numbers` array in your request, set `numbers[].selected` to `true`, and specify the number ID with `numbers[].numberId` or the number itself with `numbers[].number`. | | `numbers[].available` | Boolean | N/A | Read-only | Specifies whether the number is currently available in the account. | | `numbers[].capabilities` | Array | N/A | Read-only | For WhatsApmp settings, will always consist of a single element, `WHATSAPP`. | | `numbers[].createdAt` | Date | N/A | Read-only | The time the resource was created. | | `numbers[].number` | String | Required | Mutable | The number for sending notifications. | | `numbers[].numberId` | String | Required | Mutable | The ID of the number for sending notifications. | | `numbers[].qualityRating` | String | N/A | Read-only | The current WhatsApp quality rating for the number. | | `numbers[].selected` | Boolean | Required | Mutable | Set to `true` when specifying a specific number to use for sending notifications. | | `numbers[].type` | String | N/A | Read-only | For WhatsApp settings, the value returned is `WHATSAPP`. | | `numbers[].verifiedName` | String | N/A | Read-only | The verified name for the number. | | `provider` | String | Required | Mutable | For configuring WhatsApp settings, set the value to `CUSTOM_WHATSAPP`. | | `userAccessToken` | String | Required | Mutable | The access token for the WhatsApp business account. | | `whatsAppAccountBusinessId` | String | Required | Mutable | The ID of the WhatsApp business account. | | `status` | String | N/A | Read-only | The status of the creation of the delivery settings. In the response to the create request, the value is `Pending`. Status changes to `Created` after the configuration has been completed. | | `type` | String | N/A | Read-only | For WhatsApp settings, the value returned is `WHATSAPP`. | | `updatedAt` | Date | N/A | Read-only | Date and time that the delivery settings were last updated. | | `whatsAppTemplate` | Object | N/A | Read-only | Included in the response if you included `expand=whatsAppTemplates` as a query parameter when getting the WhatsApp delivery settings. Refer to the [Read WhatsApp Delivery Settings (including templates)](instant-messaging-delivery-settings/read_whatsapp_delivery_settings_including_templates.html) example. | | `whatsAppTemplate.category` | String | N/A | Read-only | The category of the template. Currently will always be `AUTHENTICATION`. | | `whatsAppTemplate.id` | String | N/A | Read-only | The WhatsApp-provided ID of the template. | | `whatsAppTemplate.language` | String | N/A | Read-only | The language of the template. | | `whatsAppTemplate.name` | String | N/A | Read-only | The name of the template. |