Supported Formats

json

Examples

curl -X POST -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken"-F "password[payload]=my_secure_payload"-F "password[files][]=@/path/to/file/file1.extension" -F "password[files][]=@/path/to/file/file2.extension" https://pwpush.com/p.json

Params

Param name Description
password
required

Push details

Validations:

  • Must be a Hash

password[payload]
required

The URL encoded password or secret text to share.

Validations:

  • Must be a String

password[files]
optional

File(s) to upload and attach to the push.

Validations:

  • Must be an array of any type

password[passphrase]
optional

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

Validations:

  • Must be a String

password[note]
optional , blank allowed

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

Validations:

  • Must be a String

password[expire_after_days]
optional

Expire secret link and delete after this many days.

Validations:

  • Must be a Integer

password[expire_after_views]
optional

Expire secret link and delete after this many views.

Validations:

  • Must be a Integer

password[deletable_by_viewer]
optional

Allow users to delete passwords once retrieved.

Validations:

  • Must be one of: true, false.

password[retrieval_step]
optional

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

Validations:

  • Must be one of: true, false.

password[kind]
optional

The kind of push to create. If ‘url’, the generated secret link will 303 redirect the URL in the payload. Defaults to ‘text’.

Validations:

  • Must be one of: text, file, url.