A URL token is a token that can be inserted into a URL to provide anonymous, unauthenticated access to a resource

Properties:

  • created_at - (read-only) when the URL token was created
  • data - JSON data that provides information about the resource the URL token authorizes. The needed data varies depending on the purpose of the URL token. data should include package_id for send_package_to_user, dropbox_id for send_package_to_dropbox and node_id/file_id for view_shared_file
  • expires_at - when the URL token expires, can be null for no expiration
  • id - (read-only) a short, unique string
  • purpose - (required, read-only after create) "send_package_to_user" | "send_package_to_dropbox" | "view_shared_file"
  • updated_at - (read-only) when the URL token was updated
  • value - (read-only) the string value of the URL token, should be inserted into whatever URL is being generated

Query Parameters (for GET):

  • purpose - "send_package_to_user", "send_package_to_dropbox", "view_shared_file"

GET and POST

GET, PUT, DELETE

POST /api/v1/url_tokens
{
  "purpose": "send_package_to_dropbox",
  "data": {
    "dropbox_id": "2"
  },
  "expires_at": "2015-07-08T15:00:00Z"
}
201 Created
{
  "id": "1"
  "value": "abcd1234",
  "purpose": "send_package_to_dropbox",
  "data": {
    "dropbox_id": "2"
  },
  "expires_at": "2015-07-08T15:00:00Z"
}
Video player

Video

×

Reset your Password Password resets are handled on the Support Site

×