Table Of Content

Amazon Pinpoint REST API Reference Amazon Pinpoint REST API Reference Amazon Pinpoint: REST API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Pinpoint REST API Reference Table of Contents Welcome........................................................................................................................................... 1 Choosing between Amazon Pinpoint and Amazon Simple Email Service (SES) ..................................... 1 Regional availability................................................................................................................... 1 Example REST request and response ............................................................................................ 1 Hypertext Application Language .................................................................................................. 2 Operations........................................................................................................................................ 3 Resources........................................................................................................................................ 11 Active Template Version ............................................................................................................ 12 URI................................................................................................................................. 13 HTTP methods................................................................................................................. 13 Schemas.......................................................................................................................... 15 Properties........................................................................................................................ 15 See also.......................................................................................................................... 16 ADM Channel........................................................................................................................... 16 URI................................................................................................................................. 16 HTTP methods................................................................................................................. 17 Schemas.......................................................................................................................... 21 Properties........................................................................................................................ 21 See also.......................................................................................................................... 23 APNs Channel.......................................................................................................................... 24 URI................................................................................................................................. 24 HTTP methods................................................................................................................. 25 Schemas.......................................................................................................................... 29 Properties........................................................................................................................ 29 See also.......................................................................................................................... 33 APNs Sandbox Channel ............................................................................................................. 33 URI................................................................................................................................. 34 HTTP methods................................................................................................................. 34 Schemas.......................................................................................................................... 38 Properties........................................................................................................................ 39 See also.......................................................................................................................... 42 APNs VoIP Channel ................................................................................................................... 43 URI................................................................................................................................. 43 HTTP methods................................................................................................................. 43 Schemas.......................................................................................................................... 47 Properties........................................................................................................................ 48 See also.......................................................................................................................... 51 APNs VoIP Sandbox Channel ...................................................................................................... 52 URI................................................................................................................................. 52 HTTP methods................................................................................................................. 52 Schemas.......................................................................................................................... 56 Properties........................................................................................................................ 57 See also.......................................................................................................................... 60 App........................................................................................................................................ 61 URI................................................................................................................................. 61 HTTP methods................................................................................................................. 62 Schemas.......................................................................................................................... 64 Properties........................................................................................................................ 65 See also.......................................................................................................................... 66 Application Metrics................................................................................................................... 67 URI................................................................................................................................. 67 HTTP methods................................................................................................................. 67 Schemas.......................................................................................................................... 70 Properties........................................................................................................................ 71 iii Amazon Pinpoint REST API Reference See also.......................................................................................................................... 73 Apps....................................................................................................................................... 74 URI................................................................................................................................. 74 HTTP methods................................................................................................................. 74 Schemas.......................................................................................................................... 77 Properties........................................................................................................................ 78 See also.......................................................................................................................... 79 Attributes................................................................................................................................ 80 URI................................................................................................................................. 80 HTTP methods................................................................................................................. 80 Schemas.......................................................................................................................... 83 Properties........................................................................................................................ 84 See also.......................................................................................................................... 85 Baidu Channel.......................................................................................................................... 85 URI................................................................................................................................. 86 HTTP methods................................................................................................................. 86 Schemas.......................................................................................................................... 90 Properties........................................................................................................................ 90 See also.......................................................................................................................... 93 Campaign................................................................................................................................ 94 URI................................................................................................................................. 94 HTTP methods................................................................................................................. 94 Schemas.......................................................................................................................... 98 Properties...................................................................................................................... 112 See also........................................................................................................................ 138 Campaign Activities................................................................................................................ 139 URI............................................................................................................................... 139 HTTP methods............................................................................................................... 139 Schemas........................................................................................................................ 141 Properties...................................................................................................................... 142 See also........................................................................................................................ 144 Campaign Metrics................................................................................................................... 145 URI............................................................................................................................... 145 HTTP methods............................................................................................................... 145 Schemas........................................................................................................................ 148 Properties...................................................................................................................... 149 See also........................................................................................................................ 152 Campaign Version................................................................................................................... 152 URI............................................................................................................................... 152 HTTP methods............................................................................................................... 152 Schemas........................................................................................................................ 154 Properties...................................................................................................................... 162 See also........................................................................................................................ 184 Campaign Versions................................................................................................................. 184 URI............................................................................................................................... 185 HTTP methods............................................................................................................... 185 Schemas........................................................................................................................ 187 Properties...................................................................................................................... 194 See also........................................................................................................................ 217 Campaigns............................................................................................................................. 217 URI............................................................................................................................... 217 HTTP methods............................................................................................................... 218 Schemas........................................................................................................................ 221 Properties...................................................................................................................... 242 See also........................................................................................................................ 268 Channels............................................................................................................................... 269 URI............................................................................................................................... 269 iv Amazon Pinpoint REST API Reference HTTP methods............................................................................................................... 269 Schemas........................................................................................................................ 270 Properties...................................................................................................................... 271 See also........................................................................................................................ 273 Email Channel........................................................................................................................ 273 URI............................................................................................................................... 273 HTTP methods............................................................................................................... 273 Schemas........................................................................................................................ 277 Properties...................................................................................................................... 278 See also........................................................................................................................ 281 Email Template...................................................................................................................... 282 URI............................................................................................................................... 283 HTTP methods............................................................................................................... 283 Schemas........................................................................................................................ 292 Properties...................................................................................................................... 293 See also........................................................................................................................ 297 Endpoint............................................................................................................................... 298 URI............................................................................................................................... 299 HTTP methods............................................................................................................... 299 Schemas........................................................................................................................ 303 Properties...................................................................................................................... 305 See also........................................................................................................................ 312 Endpoints.............................................................................................................................. 313 URI............................................................................................................................... 313 HTTP methods............................................................................................................... 313 Schemas........................................................................................................................ 315 Properties...................................................................................................................... 316 See also........................................................................................................................ 322 Event Stream......................................................................................................................... 322 URI............................................................................................................................... 322 HTTP methods............................................................................................................... 322 Schemas........................................................................................................................ 326 Properties...................................................................................................................... 327 See also........................................................................................................................ 329 Events................................................................................................................................... 329 URI............................................................................................................................... 330 HTTP methods............................................................................................................... 330 Schemas........................................................................................................................ 331 Properties...................................................................................................................... 332 See also........................................................................................................................ 340 Export Job............................................................................................................................. 341 URI............................................................................................................................... 341 HTTP methods............................................................................................................... 341 Schemas........................................................................................................................ 343 Properties...................................................................................................................... 344 See also........................................................................................................................ 347 Export Jobs........................................................................................................................... 347 URI............................................................................................................................... 347 HTTP methods............................................................................................................... 347 Schemas........................................................................................................................ 350 Properties...................................................................................................................... 352 See also........................................................................................................................ 356 GCM Channel......................................................................................................................... 357 URI............................................................................................................................... 357 HTTP methods............................................................................................................... 357 Schemas........................................................................................................................ 361 Properties...................................................................................................................... 362 v Amazon Pinpoint REST API Reference See also........................................................................................................................ 364 Import Job............................................................................................................................ 365 URI............................................................................................................................... 365 HTTP methods............................................................................................................... 365 Schemas........................................................................................................................ 367 Properties...................................................................................................................... 368 See also........................................................................................................................ 371 Import Jobs........................................................................................................................... 372 URI............................................................................................................................... 372 HTTP methods............................................................................................................... 372 Schemas........................................................................................................................ 375 Properties...................................................................................................................... 377 See also........................................................................................................................ 382 In-App Messages.................................................................................................................... 383 URI............................................................................................................................... 383 HTTP methods............................................................................................................... 383 Schemas........................................................................................................................ 385 Properties...................................................................................................................... 387 See also........................................................................................................................ 396 In-App Template.................................................................................................................... 397 URI............................................................................................................................... 397 HTTP methods............................................................................................................... 397 Schemas........................................................................................................................ 407 Properties...................................................................................................................... 411 See also........................................................................................................................ 418 Journey................................................................................................................................. 420 URI............................................................................................................................... 420 HTTP methods............................................................................................................... 420 Schemas........................................................................................................................ 424 Properties...................................................................................................................... 426 See also........................................................................................................................ 451 Journey Activity Execution Metrics ............................................................................................ 452 URI............................................................................................................................... 453 HTTP methods............................................................................................................... 453 Schemas........................................................................................................................ 455 Properties...................................................................................................................... 455 See also........................................................................................................................ 457 Journey Engagement Metrics................................................................................................... 457 URI............................................................................................................................... 457 HTTP methods............................................................................................................... 458 Schemas........................................................................................................................ 461 Properties...................................................................................................................... 462 See also........................................................................................................................ 464 Journey Execution Metrics ....................................................................................................... 465 URI............................................................................................................................... 465 HTTP methods............................................................................................................... 465 Schemas........................................................................................................................ 467 Properties...................................................................................................................... 467 See also........................................................................................................................ 468 Journey State......................................................................................................................... 469 URI............................................................................................................................... 469 HTTP methods............................................................................................................... 469 Schemas........................................................................................................................ 471 Properties...................................................................................................................... 472 See also........................................................................................................................ 495 Journeys................................................................................................................................ 496 URI............................................................................................................................... 496 vi Amazon Pinpoint REST API Reference HTTP methods............................................................................................................... 496 Schemas........................................................................................................................ 499 Properties...................................................................................................................... 502 See also........................................................................................................................ 528 Messages............................................................................................................................... 528 URI............................................................................................................................... 529 HTTP methods............................................................................................................... 529 Schemas........................................................................................................................ 530 Properties...................................................................................................................... 533 See also........................................................................................................................ 559 OTP Message......................................................................................................................... 560 URI............................................................................................................................... 560 HTTP methods............................................................................................................... 560 Schemas........................................................................................................................ 561 Properties...................................................................................................................... 562 See also........................................................................................................................ 567 Phone Number Validate .......................................................................................................... 568 URI............................................................................................................................... 568 HTTP methods............................................................................................................... 568 Schemas........................................................................................................................ 569 Properties...................................................................................................................... 570 See also........................................................................................................................ 572 Push Notification Template ...................................................................................................... 573 URI............................................................................................................................... 573 HTTP methods............................................................................................................... 573 Schemas........................................................................................................................ 583 Properties...................................................................................................................... 586 See also........................................................................................................................ 594 Recommender Model .............................................................................................................. 596 URI............................................................................................................................... 596 HTTP methods............................................................................................................... 596 Schemas........................................................................................................................ 600 Properties...................................................................................................................... 601 See also........................................................................................................................ 606 Recommender Models............................................................................................................. 607 URI............................................................................................................................... 607 HTTP methods............................................................................................................... 607 Schemas........................................................................................................................ 610 Properties...................................................................................................................... 611 See also........................................................................................................................ 616 Segment................................................................................................................................ 617 URI............................................................................................................................... 617 HTTP methods............................................................................................................... 617 Schemas........................................................................................................................ 621 Properties...................................................................................................................... 627 See also........................................................................................................................ 637 Segment Export Jobs .............................................................................................................. 638 URI............................................................................................................................... 638 HTTP methods............................................................................................................... 638 Schemas........................................................................................................................ 640 Properties...................................................................................................................... 641 See also........................................................................................................................ 644 Segment Import Jobs .............................................................................................................. 644 URI............................................................................................................................... 645 HTTP methods............................................................................................................... 645 Schemas........................................................................................................................ 647 Properties...................................................................................................................... 648 vii Amazon Pinpoint REST API Reference See also........................................................................................................................ 652 Segment Version.................................................................................................................... 652 URI............................................................................................................................... 652 HTTP methods............................................................................................................... 652 Schemas........................................................................................................................ 654 Properties...................................................................................................................... 657 See also........................................................................................................................ 667 Segment Versions................................................................................................................... 667 URI............................................................................................................................... 667 HTTP methods............................................................................................................... 667 Schemas........................................................................................................................ 669 Properties...................................................................................................................... 672 See also........................................................................................................................ 682 Segments.............................................................................................................................. 682 URI............................................................................................................................... 683 HTTP methods............................................................................................................... 683 Schemas........................................................................................................................ 686 Properties...................................................................................................................... 694 See also........................................................................................................................ 704 Settings................................................................................................................................. 705 URI............................................................................................................................... 705 HTTP methods............................................................................................................... 705 Schemas........................................................................................................................ 708 Properties...................................................................................................................... 709 See also........................................................................................................................ 713 SMS Channel......................................................................................................................... 714 URI............................................................................................................................... 714 HTTP methods............................................................................................................... 714 Schemas........................................................................................................................ 718 Properties...................................................................................................................... 719 See also........................................................................................................................ 721 SMS Template........................................................................................................................ 722 URI............................................................................................................................... 723 HTTP methods............................................................................................................... 723 Schemas........................................................................................................................ 732 Properties...................................................................................................................... 733 See also........................................................................................................................ 737 Tags...................................................................................................................................... 738 URI............................................................................................................................... 738 HTTP methods............................................................................................................... 738 Schemas........................................................................................................................ 740 Properties...................................................................................................................... 740 See also........................................................................................................................ 741 Template Versions.................................................................................................................. 741 URI............................................................................................................................... 742 HTTP methods............................................................................................................... 742 Schemas........................................................................................................................ 744 Properties...................................................................................................................... 745 See also........................................................................................................................ 747 Templates.............................................................................................................................. 747 URI............................................................................................................................... 748 HTTP methods............................................................................................................... 748 Schemas........................................................................................................................ 750 Properties...................................................................................................................... 750 See also........................................................................................................................ 752 User...................................................................................................................................... 753 URI............................................................................................................................... 753 viii Amazon Pinpoint REST API Reference HTTP methods............................................................................................................... 753 Schemas........................................................................................................................ 756 Properties...................................................................................................................... 757 See also........................................................................................................................ 763 Users Messages...................................................................................................................... 763 URI............................................................................................................................... 764 HTTP methods............................................................................................................... 764 Schemas........................................................................................................................ 765 Properties...................................................................................................................... 768 See also........................................................................................................................ 792 Verify OTP ............................................................................................................................. 793 URI............................................................................................................................... 793 HTTP methods............................................................................................................... 793 Schemas........................................................................................................................ 794 Properties...................................................................................................................... 795 See also........................................................................................................................ 796 Voice Channel........................................................................................................................ 796 URI............................................................................................................................... 796 HTTP methods............................................................................................................... 797 Schemas........................................................................................................................ 801 Properties...................................................................................................................... 801 See also........................................................................................................................ 803 Voice Template....................................................................................................................... 804 URI............................................................................................................................... 805 HTTP methods............................................................................................................... 805 Schemas........................................................................................................................ 814 Properties...................................................................................................................... 815 See also........................................................................................................................ 819 Schema samples............................................................................................................................. 821 JourneyResponse object.......................................................................................................... 821 RawContent object................................................................................................................. 823 Overview....................................................................................................................... 823 Samples........................................................................................................................ 824 Document history........................................................................................................................... 828 ix Amazon Pinpoint REST API Reference Choosing between Amazon Pinpoint and Amazon Simple Email Service (SES) Welcome Welcome to the Amazon Pinpoint API Reference. This guide provides information about Amazon Pinpoint API resources, including supported HTTP methods, parameters, and schemas. Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send push notifications, email, SMS text messages, and voice messages. If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the quotas that apply to using the service. Choosing between Amazon Pinpoint and Amazon Simple Email Service (SES) If you send a large number of transactional emails, such as purchase confirmations or password reset messages, consider using Amazon SES. Amazon SES has an API and an SMTP interface, both of which are well suited to sending email from your applications or services. It also offers additional email features, including email receiving capabilities, configuration sets, and sending authorization capabilities. Amazon SES also includes an SMTP interface that you can integrate with your existing third-party applications, including customer relationship management (CRM) services such as Salesforce. For more information about sending email using Amazon SES, see Amazon SES API v2. Regional availability The Amazon Pinpoint API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference. In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure. Example REST request and response The following is an example of a REST request that you send to Amazon Pinpoint: GET /v1/apps/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/campaigns 1

Description:
Following this request, Amazon Pinpoint returns a response that includes the The Amazon Pinpoint REST API includes the following resources.
ebook img

Amazon Pinpoint - REST API Reference PDF

153 Pages·2017·0.94 MB·English
by  
Save to my drive
Quick download
Download
Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview Amazon Pinpoint - REST API Reference

Amazon Pinpoint REST API Reference Amazon Pinpoint REST API Reference Amazon Pinpoint: REST API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Pinpoint REST API Reference Table of Contents Welcome........................................................................................................................................... 1 Choosing between Amazon Pinpoint and Amazon Simple Email Service (SES) ..................................... 1 Regional availability................................................................................................................... 1 Example REST request and response ............................................................................................ 1 Hypertext Application Language .................................................................................................. 2 Operations........................................................................................................................................ 3 Resources........................................................................................................................................ 11 Active Template Version ............................................................................................................ 12 URI................................................................................................................................. 13 HTTP methods................................................................................................................. 13 Schemas.......................................................................................................................... 15 Properties........................................................................................................................ 15 See also.......................................................................................................................... 16 ADM Channel........................................................................................................................... 16 URI................................................................................................................................. 16 HTTP methods................................................................................................................. 17 Schemas.......................................................................................................................... 21 Properties........................................................................................................................ 21 See also.......................................................................................................................... 23 APNs Channel.......................................................................................................................... 24 URI................................................................................................................................. 24 HTTP methods................................................................................................................. 25 Schemas.......................................................................................................................... 29 Properties........................................................................................................................ 29 See also.......................................................................................................................... 33 APNs Sandbox Channel ............................................................................................................. 33 URI................................................................................................................................. 34 HTTP methods................................................................................................................. 34 Schemas.......................................................................................................................... 38 Properties........................................................................................................................ 39 See also.......................................................................................................................... 42 APNs VoIP Channel ................................................................................................................... 43 URI................................................................................................................................. 43 HTTP methods................................................................................................................. 43 Schemas.......................................................................................................................... 47 Properties........................................................................................................................ 48 See also.......................................................................................................................... 51 APNs VoIP Sandbox Channel ...................................................................................................... 52 URI................................................................................................................................. 52 HTTP methods................................................................................................................. 52 Schemas.......................................................................................................................... 56 Properties........................................................................................................................ 57 See also.......................................................................................................................... 60 App........................................................................................................................................ 61 URI................................................................................................................................. 61 HTTP methods................................................................................................................. 62 Schemas.......................................................................................................................... 64 Properties........................................................................................................................ 65 See also.......................................................................................................................... 66 Application Metrics................................................................................................................... 67 URI................................................................................................................................. 67 HTTP methods................................................................................................................. 67 Schemas.......................................................................................................................... 70 Properties........................................................................................................................ 71 iii Amazon Pinpoint REST API Reference See also.......................................................................................................................... 73 Apps....................................................................................................................................... 74 URI................................................................................................................................. 74 HTTP methods................................................................................................................. 74 Schemas.......................................................................................................................... 77 Properties........................................................................................................................ 78 See also.......................................................................................................................... 79 Attributes................................................................................................................................ 80 URI................................................................................................................................. 80 HTTP methods................................................................................................................. 80 Schemas.......................................................................................................................... 83 Properties........................................................................................................................ 84 See also.......................................................................................................................... 85 Baidu Channel.......................................................................................................................... 85 URI................................................................................................................................. 86 HTTP methods................................................................................................................. 86 Schemas.......................................................................................................................... 90 Properties........................................................................................................................ 90 See also.......................................................................................................................... 93 Campaign................................................................................................................................ 94 URI................................................................................................................................. 94 HTTP methods................................................................................................................. 94 Schemas.......................................................................................................................... 98 Properties...................................................................................................................... 112 See also........................................................................................................................ 138 Campaign Activities................................................................................................................ 139 URI............................................................................................................................... 139 HTTP methods............................................................................................................... 139 Schemas........................................................................................................................ 141 Properties...................................................................................................................... 142 See also........................................................................................................................ 144 Campaign Metrics................................................................................................................... 145 URI............................................................................................................................... 145 HTTP methods............................................................................................................... 145 Schemas........................................................................................................................ 148 Properties...................................................................................................................... 149 See also........................................................................................................................ 152 Campaign Version................................................................................................................... 152 URI............................................................................................................................... 152 HTTP methods............................................................................................................... 152 Schemas........................................................................................................................ 154 Properties...................................................................................................................... 162 See also........................................................................................................................ 184 Campaign Versions................................................................................................................. 184 URI............................................................................................................................... 185 HTTP methods............................................................................................................... 185 Schemas........................................................................................................................ 187 Properties...................................................................................................................... 194 See also........................................................................................................................ 217 Campaigns............................................................................................................................. 217 URI............................................................................................................................... 217 HTTP methods............................................................................................................... 218 Schemas........................................................................................................................ 221 Properties...................................................................................................................... 242 See also........................................................................................................................ 268 Channels............................................................................................................................... 269 URI............................................................................................................................... 269 iv Amazon Pinpoint REST API Reference HTTP methods............................................................................................................... 269 Schemas........................................................................................................................ 270 Properties...................................................................................................................... 271 See also........................................................................................................................ 273 Email Channel........................................................................................................................ 273 URI............................................................................................................................... 273 HTTP methods............................................................................................................... 273 Schemas........................................................................................................................ 277 Properties...................................................................................................................... 278 See also........................................................................................................................ 281 Email Template...................................................................................................................... 282 URI............................................................................................................................... 283 HTTP methods............................................................................................................... 283 Schemas........................................................................................................................ 292 Properties...................................................................................................................... 293 See also........................................................................................................................ 297 Endpoint............................................................................................................................... 298 URI............................................................................................................................... 299 HTTP methods............................................................................................................... 299 Schemas........................................................................................................................ 303 Properties...................................................................................................................... 305 See also........................................................................................................................ 312 Endpoints.............................................................................................................................. 313 URI............................................................................................................................... 313 HTTP methods............................................................................................................... 313 Schemas........................................................................................................................ 315 Properties...................................................................................................................... 316 See also........................................................................................................................ 322 Event Stream......................................................................................................................... 322 URI............................................................................................................................... 322 HTTP methods............................................................................................................... 322 Schemas........................................................................................................................ 326 Properties...................................................................................................................... 327 See also........................................................................................................................ 329 Events................................................................................................................................... 329 URI............................................................................................................................... 330 HTTP methods............................................................................................................... 330 Schemas........................................................................................................................ 331 Properties...................................................................................................................... 332 See also........................................................................................................................ 340 Export Job............................................................................................................................. 341 URI............................................................................................................................... 341 HTTP methods............................................................................................................... 341 Schemas........................................................................................................................ 343 Properties...................................................................................................................... 344 See also........................................................................................................................ 347 Export Jobs........................................................................................................................... 347 URI............................................................................................................................... 347 HTTP methods............................................................................................................... 347 Schemas........................................................................................................................ 350 Properties...................................................................................................................... 352 See also........................................................................................................................ 356 GCM Channel......................................................................................................................... 357 URI............................................................................................................................... 357 HTTP methods............................................................................................................... 357 Schemas........................................................................................................................ 361 Properties...................................................................................................................... 362 v Amazon Pinpoint REST API Reference See also........................................................................................................................ 364 Import Job............................................................................................................................ 365 URI............................................................................................................................... 365 HTTP methods............................................................................................................... 365 Schemas........................................................................................................................ 367 Properties...................................................................................................................... 368 See also........................................................................................................................ 371 Import Jobs........................................................................................................................... 372 URI............................................................................................................................... 372 HTTP methods............................................................................................................... 372 Schemas........................................................................................................................ 375 Properties...................................................................................................................... 377 See also........................................................................................................................ 382 In-App Messages.................................................................................................................... 383 URI............................................................................................................................... 383 HTTP methods............................................................................................................... 383 Schemas........................................................................................................................ 385 Properties...................................................................................................................... 387 See also........................................................................................................................ 396 In-App Template.................................................................................................................... 397 URI............................................................................................................................... 397 HTTP methods............................................................................................................... 397 Schemas........................................................................................................................ 407 Properties...................................................................................................................... 411 See also........................................................................................................................ 418 Journey................................................................................................................................. 420 URI............................................................................................................................... 420 HTTP methods............................................................................................................... 420 Schemas........................................................................................................................ 424 Properties...................................................................................................................... 426 See also........................................................................................................................ 451 Journey Activity Execution Metrics ............................................................................................ 452 URI............................................................................................................................... 453 HTTP methods............................................................................................................... 453 Schemas........................................................................................................................ 455 Properties...................................................................................................................... 455 See also........................................................................................................................ 457 Journey Engagement Metrics................................................................................................... 457 URI............................................................................................................................... 457 HTTP methods............................................................................................................... 458 Schemas........................................................................................................................ 461 Properties...................................................................................................................... 462 See also........................................................................................................................ 464 Journey Execution Metrics ....................................................................................................... 465 URI............................................................................................................................... 465 HTTP methods............................................................................................................... 465 Schemas........................................................................................................................ 467 Properties...................................................................................................................... 467 See also........................................................................................................................ 468 Journey State......................................................................................................................... 469 URI............................................................................................................................... 469 HTTP methods............................................................................................................... 469 Schemas........................................................................................................................ 471 Properties...................................................................................................................... 472 See also........................................................................................................................ 495 Journeys................................................................................................................................ 496 URI............................................................................................................................... 496 vi Amazon Pinpoint REST API Reference HTTP methods............................................................................................................... 496 Schemas........................................................................................................................ 499 Properties...................................................................................................................... 502 See also........................................................................................................................ 528 Messages............................................................................................................................... 528 URI............................................................................................................................... 529 HTTP methods............................................................................................................... 529 Schemas........................................................................................................................ 530 Properties...................................................................................................................... 533 See also........................................................................................................................ 559 OTP Message......................................................................................................................... 560 URI............................................................................................................................... 560 HTTP methods............................................................................................................... 560 Schemas........................................................................................................................ 561 Properties...................................................................................................................... 562 See also........................................................................................................................ 567 Phone Number Validate .......................................................................................................... 568 URI............................................................................................................................... 568 HTTP methods............................................................................................................... 568 Schemas........................................................................................................................ 569 Properties...................................................................................................................... 570 See also........................................................................................................................ 572 Push Notification Template ...................................................................................................... 573 URI............................................................................................................................... 573 HTTP methods............................................................................................................... 573 Schemas........................................................................................................................ 583 Properties...................................................................................................................... 586 See also........................................................................................................................ 594 Recommender Model .............................................................................................................. 596 URI............................................................................................................................... 596 HTTP methods............................................................................................................... 596 Schemas........................................................................................................................ 600 Properties...................................................................................................................... 601 See also........................................................................................................................ 606 Recommender Models............................................................................................................. 607 URI............................................................................................................................... 607 HTTP methods............................................................................................................... 607 Schemas........................................................................................................................ 610 Properties...................................................................................................................... 611 See also........................................................................................................................ 616 Segment................................................................................................................................ 617 URI............................................................................................................................... 617 HTTP methods............................................................................................................... 617 Schemas........................................................................................................................ 621 Properties...................................................................................................................... 627 See also........................................................................................................................ 637 Segment Export Jobs .............................................................................................................. 638 URI............................................................................................................................... 638 HTTP methods............................................................................................................... 638 Schemas........................................................................................................................ 640 Properties...................................................................................................................... 641 See also........................................................................................................................ 644 Segment Import Jobs .............................................................................................................. 644 URI............................................................................................................................... 645 HTTP methods............................................................................................................... 645 Schemas........................................................................................................................ 647 Properties...................................................................................................................... 648 vii Amazon Pinpoint REST API Reference See also........................................................................................................................ 652 Segment Version.................................................................................................................... 652 URI............................................................................................................................... 652 HTTP methods............................................................................................................... 652 Schemas........................................................................................................................ 654 Properties...................................................................................................................... 657 See also........................................................................................................................ 667 Segment Versions................................................................................................................... 667 URI............................................................................................................................... 667 HTTP methods............................................................................................................... 667 Schemas........................................................................................................................ 669 Properties...................................................................................................................... 672 See also........................................................................................................................ 682 Segments.............................................................................................................................. 682 URI............................................................................................................................... 683 HTTP methods............................................................................................................... 683 Schemas........................................................................................................................ 686 Properties...................................................................................................................... 694 See also........................................................................................................................ 704 Settings................................................................................................................................. 705 URI............................................................................................................................... 705 HTTP methods............................................................................................................... 705 Schemas........................................................................................................................ 708 Properties...................................................................................................................... 709 See also........................................................................................................................ 713 SMS Channel......................................................................................................................... 714 URI............................................................................................................................... 714 HTTP methods............................................................................................................... 714 Schemas........................................................................................................................ 718 Properties...................................................................................................................... 719 See also........................................................................................................................ 721 SMS Template........................................................................................................................ 722 URI............................................................................................................................... 723 HTTP methods............................................................................................................... 723 Schemas........................................................................................................................ 732 Properties...................................................................................................................... 733 See also........................................................................................................................ 737 Tags...................................................................................................................................... 738 URI............................................................................................................................... 738 HTTP methods............................................................................................................... 738 Schemas........................................................................................................................ 740 Properties...................................................................................................................... 740 See also........................................................................................................................ 741 Template Versions.................................................................................................................. 741 URI............................................................................................................................... 742 HTTP methods............................................................................................................... 742 Schemas........................................................................................................................ 744 Properties...................................................................................................................... 745 See also........................................................................................................................ 747 Templates.............................................................................................................................. 747 URI............................................................................................................................... 748 HTTP methods............................................................................................................... 748 Schemas........................................................................................................................ 750 Properties...................................................................................................................... 750 See also........................................................................................................................ 752 User...................................................................................................................................... 753 URI............................................................................................................................... 753 viii Amazon Pinpoint REST API Reference HTTP methods............................................................................................................... 753 Schemas........................................................................................................................ 756 Properties...................................................................................................................... 757 See also........................................................................................................................ 763 Users Messages...................................................................................................................... 763 URI............................................................................................................................... 764 HTTP methods............................................................................................................... 764 Schemas........................................................................................................................ 765 Properties...................................................................................................................... 768 See also........................................................................................................................ 792 Verify OTP ............................................................................................................................. 793 URI............................................................................................................................... 793 HTTP methods............................................................................................................... 793 Schemas........................................................................................................................ 794 Properties...................................................................................................................... 795 See also........................................................................................................................ 796 Voice Channel........................................................................................................................ 796 URI............................................................................................................................... 796 HTTP methods............................................................................................................... 797 Schemas........................................................................................................................ 801 Properties...................................................................................................................... 801 See also........................................................................................................................ 803 Voice Template....................................................................................................................... 804 URI............................................................................................................................... 805 HTTP methods............................................................................................................... 805 Schemas........................................................................................................................ 814 Properties...................................................................................................................... 815 See also........................................................................................................................ 819 Schema samples............................................................................................................................. 821 JourneyResponse object.......................................................................................................... 821 RawContent object................................................................................................................. 823 Overview....................................................................................................................... 823 Samples........................................................................................................................ 824 Document history........................................................................................................................... 828 ix Amazon Pinpoint REST API Reference Choosing between Amazon Pinpoint and Amazon Simple Email Service (SES) Welcome Welcome to the Amazon Pinpoint API Reference. This guide provides information about Amazon Pinpoint API resources, including supported HTTP methods, parameters, and schemas. Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send push notifications, email, SMS text messages, and voice messages. If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the quotas that apply to using the service. Choosing between Amazon Pinpoint and Amazon Simple Email Service (SES) If you send a large number of transactional emails, such as purchase confirmations or password reset messages, consider using Amazon SES. Amazon SES has an API and an SMTP interface, both of which are well suited to sending email from your applications or services. It also offers additional email features, including email receiving capabilities, configuration sets, and sending authorization capabilities. Amazon SES also includes an SMTP interface that you can integrate with your existing third-party applications, including customer relationship management (CRM) services such as Salesforce. For more information about sending email using Amazon SES, see Amazon SES API v2. Regional availability The Amazon Pinpoint API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference. In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure. Example REST request and response The following is an example of a REST request that you send to Amazon Pinpoint: GET /v1/apps/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/campaigns 1

Description:
Following this request, Amazon Pinpoint returns a response that includes the The Amazon Pinpoint REST API includes the following resources.
See more

The list of books you might like

Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.
DMCA & Copyright: Dear all, most of the website is community built, users are uploading hundred of books everyday, which makes really hard for us to identify copyrighted material, please contact us if you want any material removed.
Copyright @ PDFdrive.to, 2022 | We love our users