Amazon Pinpoint
REST API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Operations

The Amazon Pinpoint REST API includes the following operations.

  • CreateApp

    Creates an application.

  • CreateCampaign

    Creates a new campaign for an application or updates the settings of an existing campaign for an application.

  • CreateExportJob

    Creates a new export job for an application.

  • CreateImportJob

    Creates a new import job for an application.

  • CreateSegment

    Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

  • DeleteAdmChannel

    Disables the ADM channel for an application and deletes any existing settings for the channel.

  • DeleteApnsChannel

    Disables the APNs channel for an application and deletes any existing settings for the channel.

  • DeleteApnsSandboxChannel

    Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

  • DeleteApnsVoipChannel

    Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

  • DeleteApnsVoipSandboxChannel

    Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

  • DeleteApp

    Deletes an application.

  • DeleteBaiduChannel

    Disables the Baidu channel for an application and deletes any existing settings for the channel.

  • DeleteCampaign

    Deletes a campaign from an application.

  • DeleteEmailChannel

    Disables the email channel for an application and deletes any existing settings for the channel.

  • DeleteEndpoint

    Deletes an endpoint from an application.

  • DeleteEventStream

    Deletes the event stream for an application.

  • DeleteGcmChannel

    Disables the GCM channel for an application and deletes any existing settings for the channel.

  • DeleteSegment

    Deletes a segment from an application.

  • DeleteSmsChannel

    Disables the SMS channel for an application and deletes any existing settings for the channel.

  • DeleteUserEndpoints

    Deletes all the endpoints that are associated with a specific user ID.

  • DeleteVoiceChannel

    Disables the voice channel for an application and deletes any existing settings for the channel.

  • GetAdmChannel

    Retrieves information about the status and settings of the ADM channel for an application.

  • GetApnsChannel

    Retrieves information about the status and settings of the APNs channel for an application.

  • GetApnsSandboxChannel

    Retrieves information about the status and settings of the APNs sandbox channel for an application.

  • GetApnsVoipChannel

    Retrieves information about the status and settings of the APNs VoIP channel for an application.

  • GetApnsVoipSandboxChannel

    Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

  • GetApp

    Retrieves information about an application.

  • GetApplicationDateRangeKpi

    Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

  • GetApplicationSettings

    Retrieves information about the settings for an application.

  • GetApps

    Retrieves information about all of your applications.

  • GetBaiduChannel

    Retrieves information about the status and settings of the Baidu channel for an application.

  • GetCampaign

    Retrieves information about the status, configuration, and other settings for a campaign.

  • GetCampaignActivities

    Retrieves information about the activity performed by a campaign.

  • GetCampaignDateRangeKpi

    Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

  • GetCampaigns

    Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

  • GetCampaignVersion

    Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

  • GetCampaignVersions

    Retrieves information about the status, configuration, and other settings for all versions of a specific campaign.

  • GetChannels

    Retrieves information about the history and status of each channel for an application.

  • GetEmailChannel

    Retrieves information about the status and settings of the email channel for an application.

  • GetEndpoint

    Retrieves information about the settings and attributes of a specific endpoint for an application.

  • GetEventStream

    Retrieves information about the event stream settings for an application.

  • GetExportJob

    Retrieves information about the status and settings of a specific export job for an application.

  • GetExportJobs

    Retrieves information about the status and settings of all the export jobs for an application.

  • GetGcmChannel

    Retrieves information about the status and settings of the GCM channel for an application.

  • GetImportJob

    Retrieves information about the status and settings of a specific import job for an application.

  • GetImportJobs

    Retrieves information about the status and settings of all the import jobs for an application.

  • GetSegment

    Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

  • GetSegmentExportJobs

    Retrieves information about the status and settings of the export jobs for a segment.

  • GetSegmentImportJobs

    Retrieves information about the status and settings of the import jobs for a segment.

  • GetSegments

    Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

  • GetSegmentVersion

    Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

  • GetSegmentVersions

    Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application.

  • GetSmsChannel

    Retrieves information about the status and settings of the SMS channel for an application.

  • GetUserEndpoints

    Retrieves information about all the endpoints that are associated with a specific user ID.

  • GetVoiceChannel

    Retrieves information about the status and settings of the voice channel for an application.

  • ListTagsForResource

    Retrieves all the tags (keys and values) that are associated with an application, campaign, or segment.

  • PhoneNumberValidate

    Retrieves information about a phone number.

  • PutEvents

    Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

  • PutEventStream

    Creates a new event stream for an application or updates the settings of an existing event stream for an application.

  • RemoveAttributes

    Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

  • SendMessages

    Creates and sends a direct message.

  • SendUsersMessages

    Creates and sends a message to a list of users.

  • TagResource

    Adds one or more tags (keys and values) to an application, campaign, or segment.

  • UntagResource

    Removes one or more tags (keys and values) from an application, campaign, or segment.

  • UpdateAdmChannel

    Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

  • UpdateApnsChannel

    Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

  • UpdateApnsSandboxChannel

    Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

  • UpdateApnsVoipChannel

    Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

  • UpdateApnsVoipSandboxChannel

    Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

  • UpdateApplicationSettings

    Updates the settings for an application.

  • UpdateBaiduChannel

    Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

  • UpdateCampaign

    Updates the settings for a campaign.

  • UpdateEmailChannel

    Enables the email channel for an application or updates the status and settings of the email channel for an application.

  • UpdateEndpoint

    Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.

  • UpdateEndpointsBatch

    Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.

  • UpdateGcmChannel

    Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

  • UpdateSegment

    Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

  • UpdateSmsChannel

    Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

  • UpdateVoiceChannel

    Enables the voice channel for an application or updates the status and settings of the voice channel for an application.