Supported Formats

json

Examples

curl -X POST -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" --data "url[payload]=myurl&url[expire_after_days]=2&url[expire_after_views]=10" https://pwpush.com/r.json

Params

Param name Description
url
required

Push details

Validations:

  • Must be a Hash

url[payload]
required

The URL encoded URL to redirect to.

Validations:

  • Must be a String

url[passphrase]
optional

Require recipients to enter this passphrase to view the created push.

Validations:

  • Must be a String

url[note]
optional , blank allowed

If authenticated, the URL encoded note for this push. Visible only to the push creator.

Validations:

  • Must be a String

url[expire_after_days]
optional

Expire secret link and delete after this many days.

Validations:

  • Must be a Integer

url[expire_after_views]
optional

Expire secret link and delete after this many views.

Validations:

  • Must be a Integer

url[retrieval_step]
optional

Helps to avoid chat systems and URL scanners from eating up views.

Validations:

  • Must be one of: true, false.