POST /r.json
Create a new URL push.

URL Push Creation ↑

Creates a new URL push with the given payload and details.

Example Request ↑

curl -X POST \

-H "Authorization: Bearer MyAPIToken" \
-d "url[payload]=https://example.com" \
-d "url[expire_after_days]=2" \
-d "url[expire_after_views]=10" \
https://pwpush.com/r.json

Example Response ↑

{
  "url_token": "quyul5r5w18",
  "created_at": "2023-10-20T15:32:01Z",
  "expire_after_days": 2,
  "expire_after_views": 10,
  ...
}

Supported Formats

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.