Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Aws Pinpoint Push

Aws Pinpoint Push

markdownView as Markdown

Create and manage data import and export jobs.

AwsPinpointPush: Create job

POSThttps://api.lytics.io/v2/job/aws-pinpoint-push

Create a AwsPinpointPush job

Sample Request
123456789101112131415161718192021222324252627282930313233343536
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action": "string",
    "body": "string",
    "channel_type": "string",
    "from_email": "string",
    "id_field": "string",
    "keyword": "string",
    "message_type": "string",
    "origination_number": "string",
    "priority": "string",
    "project": "string",
    "region": "string",
    "reply_to_address": "string",
    "segment_ids": [
      "string"
    ],
    "sender_id": "string",
    "silent_push": true,
    "sound": "string",
    "title": "string",
    "url": "string",
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "action": "string",
      "body": "string",
      "channel_type": "string",
      "from_email": "string",
      "id_field": "string",
      "keyword": "string",
      "message_type": "string",
      "origination_number": "string",
      "priority": "string",
      "project": "string",
      "region": "string",
      "reply_to_address": "string",
      "segment_ids": [
        "string"
      ],
      "sender_id": "string",
      "silent_push": true,
      "sound": "string",
      "title": "string",
      "url": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

AwsPinpointPush: Get job

GEThttps://api.lytics.io/v2/job/aws-pinpoint-push/{id}

Get the summary of a AwsPinpointPush job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "action": "string",
      "body": "string",
      "channel_type": "string",
      "from_email": "string",
      "id_field": "string",
      "keyword": "string",
      "message_type": "string",
      "origination_number": "string",
      "priority": "string",
      "project": "string",
      "region": "string",
      "reply_to_address": "string",
      "segment_ids": [
        "string"
      ],
      "sender_id": "string",
      "silent_push": true,
      "sound": "string",
      "title": "string",
      "url": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

AwsPinpointPush: Update job

PUThttps://api.lytics.io/v2/job/aws-pinpoint-push/{id}

Update a AwsPinpointPush job

Sample Request
123456789101112131415161718192021222324252627282930313233343536
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action": "string",
    "body": "string",
    "channel_type": "string",
    "from_email": "string",
    "id_field": "string",
    "keyword": "string",
    "message_type": "string",
    "origination_number": "string",
    "priority": "string",
    "project": "string",
    "region": "string",
    "reply_to_address": "string",
    "segment_ids": [
      "string"
    ],
    "sender_id": "string",
    "silent_push": true,
    "sound": "string",
    "title": "string",
    "url": "string",
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "action": "string",
      "body": "string",
      "channel_type": "string",
      "from_email": "string",
      "id_field": "string",
      "keyword": "string",
      "message_type": "string",
      "origination_number": "string",
      "priority": "string",
      "project": "string",
      "region": "string",
      "reply_to_address": "string",
      "segment_ids": [
        "string"
      ],
      "sender_id": "string",
      "silent_push": true,
      "sound": "string",
      "title": "string",
      "url": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.actionoptionalstring

(For Apple/GCM Channel - Optional) Specify action to occur if the recipient taps the notification message

config.bodyoptionalstring

(For Apple/GCM, Email, SMS Channel) The body of the notification message/Email/SMS

config.channel_typeoptionalstring

Select Pinpoint channel type (Supported channels: Email, SMS, APNS, GCM)

config.from_emailoptionalstring

(For Email Channel Only - Optional) The verified email address to send the email message from. The default value is the FromAddress specified in Pinpoint for the email channel

config.id_fieldoptionalstring

Field that contains the address that uniquely identifies device/email to send message to

config.keywordoptionalstring

(For SMS Channel Only - Optional) The SMS program name that you provided to AWS Support when you requested your dedicated number

config.message_typeoptionalstring

(For SMS Channel Only - Optional) The SMS message type. If you plan to send time-sensitive content, specify TRANSACTIONAL. If you plan to send marketing-related content, specify PROMOTIONAL

config.origination_numberoptionalstring

(For SMS Channel Only - Optional) The number to send the SMS message from. The phone number or short code that you specify has to be associated with your Amazon Pinpoint account

config.priorityoptionalstring

(For Apple/GCM Channel - Optional) Priority for the message you are sending

config.projectoptionalstring

Select Pinpoint project

config.regionoptionalstring

AWS region that Pinpoint project resides in (us-east-2, etc.)

config.reply_to_addressoptionalstring

(For Email Channel Only - Optional) The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply. For multiple email addresses, please separate them using ",`"

config.segment_idsoptionalstring[]

Select Lytics audiences to send messages via Pinpoint channels

config.sender_idoptionalstring

(For SMS Channel Only - Optional) The sender ID to display as the sender of the message on a recipient's device

config.silent_pushoptionalboolean

(For Apple/GCM Channel - Optional) Specify whether the notification is a silent notification message

config.soundoptionalstring

(For Apple/GCM Channel - Optional) Specify sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file cannot be found or you specify default for the value, the system plays the default alert sound

config.titleoptionalstring

(For Apple/GCM, Email Channel) The title to display above the notification message on the recipient's device. If you are sending an Email Notification, then this would be the subject for the email.

config.urloptionalstring

(For Apple/GCM Channel - Optional) Specify the URL to open in the recipient's default mobile browser, if a recipient taps the notification message and the value of the Action property is URL

config.withbackfilloptionalboolean

Send messages to users who are already in the selected Lytics audiences

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.actionoptionalstring

(For Apple/GCM Channel - Optional) Specify action to occur if the recipient taps the notification message

config.bodyoptionalstring

(For Apple/GCM, Email, SMS Channel) The body of the notification message/Email/SMS

config.channel_typeoptionalstring

Select Pinpoint channel type (Supported channels: Email, SMS, APNS, GCM)

config.from_emailoptionalstring

(For Email Channel Only - Optional) The verified email address to send the email message from. The default value is the FromAddress specified in Pinpoint for the email channel

config.id_fieldoptionalstring

Field that contains the address that uniquely identifies device/email to send message to

config.keywordoptionalstring

(For SMS Channel Only - Optional) The SMS program name that you provided to AWS Support when you requested your dedicated number

config.message_typeoptionalstring

(For SMS Channel Only - Optional) The SMS message type. If you plan to send time-sensitive content, specify TRANSACTIONAL. If you plan to send marketing-related content, specify PROMOTIONAL

config.origination_numberoptionalstring

(For SMS Channel Only - Optional) The number to send the SMS message from. The phone number or short code that you specify has to be associated with your Amazon Pinpoint account

config.priorityoptionalstring

(For Apple/GCM Channel - Optional) Priority for the message you are sending

config.projectoptionalstring

Select Pinpoint project

config.regionoptionalstring

AWS region that Pinpoint project resides in (us-east-2, etc.)

config.reply_to_addressoptionalstring

(For Email Channel Only - Optional) The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply. For multiple email addresses, please separate them using ",`"

config.segment_idsoptionalstring[]

Select Lytics audiences to send messages via Pinpoint channels

config.sender_idoptionalstring

(For SMS Channel Only - Optional) The sender ID to display as the sender of the message on a recipient's device

config.silent_pushoptionalboolean

(For Apple/GCM Channel - Optional) Specify whether the notification is a silent notification message

config.soundoptionalstring

(For Apple/GCM Channel - Optional) Specify sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file cannot be found or you specify default for the value, the system plays the default alert sound

config.titleoptionalstring

(For Apple/GCM, Email Channel) The title to display above the notification message on the recipient's device. If you are sending an Email Notification, then this would be the subject for the email.

config.urloptionalstring

(For Apple/GCM Channel - Optional) Specify the URL to open in the recipient's default mobile browser, if a recipient taps the notification message and the value of the Action property is URL

config.withbackfilloptionalboolean

Send messages to users who are already in the selected Lytics audiences

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring