# Amazon Pinpoint API

> Amazon Pinpoint API on Apizie: 122 endpoints (Retrieves information about all the applications that are associated with your Amazon Pinpoint account., Creates an application., Retrieves information about the status, configuration, and other settings for all the campaigns that are…, Creates a new campaign for an application or updates the settings of an existing campaign for an application., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-pinpoint`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-pinpoint
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-pinpoint/openapi.json

Doc Engage API - Amazon Pinpoint API

## Endpoints

### Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Creates an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about the status, configuration, and other settings for all the campaigns that are…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-campaigns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Creates a new campaign for an application or updates the settings of an existing campaign for an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Retrieves the content and settings of a message template for messages that are sent through the email channel.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-email-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Creates a message template for messages that are sent through the email channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-email-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| body | object | yes | JSON request body |

### Updates an existing message template for messages that are sent through the email channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-email-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| create-new-version | boolean | no | Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version;… |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |
| body | object | yes | JSON request body |

### Deletes a message template for messages that were sent through the email channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-email-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Retrieves information about the status and settings of all the export jobs for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-export-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Creates an export job for an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-export-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Retrieves information about the status and settings of all the import jobs for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-import-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Creates an import job for an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Retrieves the content and settings of a message template for messages sent through the in-app channel.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-in-app-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Creates a new message template for messages using the in-app message channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-in-app-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| body | object | yes | JSON request body |

### Updates an existing message template for messages sent through the in-app message channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-in-app-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| create-new-version | boolean | no | Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version;… |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |
| body | object | yes | JSON request body |

### Deletes a message template for messages sent using the in-app message channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-in-app-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Retrieves information about the status, configuration, and other settings for all the journeys that are…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/list-journeys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Creates a journey for an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-journey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Retrieves the content and settings of a message template for messages that are sent through a push…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-push-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Creates a message template for messages that are sent through a push notification channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-push-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| body | object | yes | JSON request body |

### Updates an existing message template for messages that are sent through a push notification channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-push-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| create-new-version | boolean | no | Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version;… |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |
| body | object | yes | JSON request body |

### Deletes a message template for messages that were sent through a push notification channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-push-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Retrieves information about all the recommender model configurations that are associated with your Amazon…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-recommender-configurations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Creates an Amazon Pinpoint configuration for a recommender model.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-recommender-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about the configuration, dimension, and other settings for all the segments that are…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-segments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Creates a new segment for an application or updates the configuration, dimension, and other settings for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-segment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-sms-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Creates a message template for messages that are sent through the SMS channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-sms-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| body | object | yes | JSON request body |

### Updates an existing message template for messages that are sent through the SMS channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-sms-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| create-new-version | boolean | no | Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version;… |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |
| body | object | yes | JSON request body |

### Deletes a message template for messages that were sent through the SMS channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-sms-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Retrieves the content and settings of a message template for messages that are sent through the voice channel.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-voice-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Creates a message template for messages that are sent through the voice channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/create-voice-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| body | object | yes | JSON request body |

### Updates an existing message template for messages that are sent through the voice channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-voice-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| create-new-version | boolean | no | Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version;… |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |
| body | object | yes | JSON request body |

### Deletes a message template for messages that were sent through the voice channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-voice-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| version | string | no | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers… |

### Retrieves information about the status and settings of the ADM channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-adm-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the ADM channel for an application or updates the status and settings of the ADM channel for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-adm-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the ADM channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-adm-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status and settings of the APNs channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-apns-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the APNs channel for an application or updates the status and settings of the APNs channel for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-apns-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the APNs channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-apns-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status and settings of the APNs sandbox channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-apns-sandbox-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-apns-sandbox-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-apns-sandbox-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status and settings of the APNs VoIP channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-apns-voip-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-apns-voip-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-apns-voip-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-apns-voip-sandbox-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-apns-voip-sandbox-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-apns-voip-sandbox-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Deletes an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status and settings of the Baidu channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-baidu-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-baidu-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the Baidu channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-baidu-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status, configuration, and other settings for a campaign.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| campaign-id | string | yes | The unique identifier for the campaign. |

### Updates the configuration and other settings for a campaign.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| campaign-id | string | yes | The unique identifier for the campaign. |
| body | object | yes | JSON request body |

### Deletes a campaign from an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| campaign-id | string | yes | The unique identifier for the campaign. |

### Retrieves information about the status and settings of the email channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-email-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the email channel for an application or updates the status and settings of the email channel for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-email-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the email channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-email-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the settings and attributes of a specific endpoint for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| endpoint-id | string | yes | The unique identifier for the endpoint. |

### Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| endpoint-id | string | yes | The unique identifier for the endpoint. |
| body | object | yes | JSON request body |

### Deletes an endpoint from an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| endpoint-id | string | yes | The unique identifier for the endpoint. |

### Retrieves information about the event stream settings for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-event-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Creates a new event stream for an application or updates the settings of an existing event stream for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/put-event-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Deletes the event stream for an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-event-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status and settings of the GCM channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-gcm-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the GCM channel for an application or updates the status and settings of the GCM channel for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-gcm-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the GCM channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-gcm-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status, configuration, and other settings for a journey.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-journey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-id | string | yes | The unique identifier for the journey. |

### Updates the configuration and other settings for a journey.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-journey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-id | string | yes | The unique identifier for the journey. |
| body | object | yes | JSON request body |

### Deletes a journey from an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-journey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-id | string | yes | The unique identifier for the journey. |

### Retrieves information about an Amazon Pinpoint configuration for a recommender model.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-recommender-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| recommender-id | string | yes | The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint… |

### Updates an Amazon Pinpoint configuration for a recommender model.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-recommender-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| recommender-id | string | yes | The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint… |
| body | object | yes | JSON request body |

### Deletes an Amazon Pinpoint configuration for a recommender model.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-recommender-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| recommender-id | string | yes | The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint… |

### Retrieves information about the configuration, dimension, and other settings for a specific segment that's…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-segment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| segment-id | string | yes | The unique identifier for the segment. |

### Creates a new segment for an application or updates the configuration, dimension, and other settings for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-segment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| segment-id | string | yes | The unique identifier for the segment. |
| body | object | yes | JSON request body |

### Deletes a segment from an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-segment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| segment-id | string | yes | The unique identifier for the segment. |

### Retrieves information about the status and settings of the SMS channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-sms-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the SMS channel for an application or updates the status and settings of the SMS channel for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-sms-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the SMS channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-sms-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about all the endpoints that are associated with a specific user ID.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-user-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| user-id | string | yes | The unique identifier for the user. |

### Deletes all the endpoints that are associated with a specific user ID.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-user-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| user-id | string | yes | The unique identifier for the user. |

### Retrieves information about the status and settings of the voice channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-voice-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Enables the voice channel for an application or updates the status and settings of the voice channel for an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-voice-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Disables the voice channel for an application and deletes any existing settings for the channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/delete-voice-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-application-date-range-kpi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| end-time | string | no | The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in… |
| kpi-name | string | yes | The name of the metric, also referred to as a key performance indicator (KPI) , to retrieve data for. This value describes the associated… |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| start-time | string | no | The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in… |

### Retrieves information about the settings for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-application-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Updates the settings for an application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-application-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Retrieves information about all the activities for a campaign.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-campaign-activities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| campaign-id | string | yes | The unique identifier for the campaign. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-campaign-date-range-kpi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| campaign-id | string | yes | The unique identifier for the campaign. |
| end-time | string | no | The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in… |
| kpi-name | string | yes | The name of the metric, also referred to as a key performance indicator (KPI) , to retrieve data for. This value describes the associated… |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| start-time | string | no | The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in… |

### Retrieves information about the status, configuration, and other settings for a specific version of a…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-campaign-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| campaign-id | string | yes | The unique identifier for the campaign. |
| version | string | yes | The unique version number (Version property) for the campaign version. |

### Retrieves information about the status, configuration, and other settings for all versions of a campaign.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-campaign-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| campaign-id | string | yes | The unique identifier for the campaign. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Retrieves information about the history and status of each channel for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |

### Retrieves information about the status and settings of a specific export job for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-export-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| job-id | string | yes | The unique identifier for the job. |

### Retrieves information about the status and settings of a specific import job for an application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| job-id | string | yes | The unique identifier for the job. |

### Retrieves the in-app messages targeted for the provided endpoint ID.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-in-app-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| endpoint-id | string | yes | The unique identifier for the endpoint. |

### Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-journey-date-range-kpi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| end-time | string | no | The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in… |
| journey-id | string | yes | The unique identifier for the journey. |
| kpi-name | string | yes | The name of the metric, also referred to as a key performance indicator (KPI) , to retrieve data for. This value describes the associated… |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| start-time | string | no | The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in… |

### Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-journey-execution-activity-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-activity-id | string | yes | The unique identifier for the journey activity. |
| journey-id | string | yes | The unique identifier for the journey. |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |

### Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-journey-execution-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-id | string | yes | The unique identifier for the journey. |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |

### Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-journey-run-execution-activity-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-activity-id | string | yes | The unique identifier for the journey activity. |
| journey-id | string | yes | The unique identifier for the journey. |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| run-id | string | yes | The unique identifier for the journey run. |

### Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-journey-run-execution-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-id | string | yes | The unique identifier for the journey. |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| run-id | string | yes | The unique identifier for the journey run. |

### Provides information about the runs of a journey.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-journey-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-id | string | yes | The unique identifier for the journey. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Retrieves information about the status and settings of the export jobs for a segment.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-segment-export-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| segment-id | string | yes | The unique identifier for the segment. |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Retrieves information about the status and settings of the import jobs for a segment.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-segment-import-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| segment-id | string | yes | The unique identifier for the segment. |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Retrieves information about the configuration, dimension, and other settings for a specific version of a…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-segment-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| segment-id | string | yes | The unique identifier for the segment. |
| version | string | yes | The unique version number (Version property) for the campaign version. |

### Retrieves information about the configuration, dimension, and other settings for all the versions of a…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-segment-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| segment-id | string | yes | The unique identifier for the segment. |
| token | string | no | The NextToken string that specifies which page of results to return in a paginated response. |

### Retrieves all the tags (keys and values) that are associated with an application, campaign, message…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resource-arn | string | yes | The Amazon Resource Name (ARN) of the resource. |

### Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resource-arn | string | yes | The Amazon Resource Name (ARN) of the resource. |
| body | object | yes | JSON request body |

### Retrieves information about all the versions of a specific message template.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/list-template-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| template-name | string | yes | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters.… |
| template-type | string | yes | The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE. |

### Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/list-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application,… |
| page-size | string | no | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign,… |
| prefix | string | no | The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns… |
| template-type | string | no | The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates… |

### Retrieves information about a phone number.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/phone-number-validate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/put-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/remove-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| attribute-type | string | yes | The type of attribute or attributes to remove. Valid values are: endpoint-custom-attributes - Custom attributes that describe endpoints,… |
| body | object | yes | JSON request body |

### Creates and sends a direct message.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/send-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Send an OTP message
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/send-otpmessage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique ID of your Amazon Pinpoint application. |
| body | object | yes | JSON request body |

### Creates and sends a message to a list of users.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/send-users-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resource-arn | string | yes | The Amazon Resource Name (ARN) of the resource. |
| tagKeys | array | yes | The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag… |

### Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-endpoints-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| body | object | yes | JSON request body |

### Cancels (stops) an active journey.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/update-journey-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| application-id | string | yes | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| journey-id | string | yes | The unique identifier for the journey. |
| body | object | yes | JSON request body |

…and 2 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-apps" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Pinpoint API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-pinpoint/get-apps with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Pinpoint API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Pinpoint itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Pinpoint API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-pinpoint.

### What is the status of the Amazon Pinpoint API?
Needs your own provider key (bring your own key)