Showpad

App · 25 actions

Run your sales content in Showpad: upload, find and update assets and tags, create Shared Spaces and trackable shares for buyers, manage user groups, export engagement, and start workflows when buyers view content or act in a Shared Space.

Actions

ActionWhat it does
Add assets to Shared SpaceAdd assets to a Shared Space, optionally in a new folder.
Add user to groupAdd a person to a user group, so they get the group's content.
Create shareCreate a share: a trackable link to one or more assets to send a buyer.
Create Shared SpaceCreate a Shared Space for a buyer, from scratch or from a template.
Create tagCreate a tag in a Division, to label assets with.
Create user groupCreate a user group, to give a set of people the same content.
Delete assetDelete an asset from the library for good.
Delete Shared SpaceDelete a Shared Space for good.
Delete tagDelete a tag.
Delete user groupDelete a user group.
Export eventsExport activity behind Showpad's reports: views, downloads, shares and Shared Space visits, with who and what was involved.
Find assetsFind assets in the Showpad library by name, type, status, Division, tags or when they were added or changed.
Get assetGet one asset with its details: type, status, Division, tags, languages, countries and dates.
Get Shared SpaceGet one Shared Space with its address, owner, settings and when someone was last active in it.
List DivisionsList the Divisions (separate content libraries) in your Showpad.
List ExperiencesList the Experiences (the branded content portals sellers open in the Showpad app).
List Shared SpacesList Shared Spaces (the pages you share content and talk with buyers in), by status, title, owner or recent activity.
List tagsList the tags used to label assets, optionally in one Division or matching a name.
List user groupsList the user groups that decide who sees which content.
List usersList the people in your Showpad, or find them by email.
Remove user from groupTake a person out of a user group.
Update assetChange an asset's name, description, tags, dates or sharing, or archive it.
Update Shared SpaceChange a Shared Space's title, description or settings, or archive it.
Upload assetAdd a file to the Showpad library as a new asset in a Division.
Upload new asset versionReplace an asset's file with a new version.

Add assets to Shared Space

Add assets to a Shared Space, optionally in a new folder. Assets that can't be shared are reported, not added.

Inputs

Shared Spaceshared_space_idtextRequired
The Shared Space. Pick one, or give its ID from an earlier step.
Assetsasset_idslistRequired
The assets to add.
Folderfolder_nametext
Put them in a new folder with this name.

Outputs

added_countnumber
How many assets were added
failed_countnumber
How many couldn't be added
failed_itemslist
The assets that couldn't be added
Example output
{
  "added_count": 1,
  "failed_count": 1,
  "failed_items": [
    {
      "assetId": "12f08190fe1ffd87c2f8689d9bf11b1a",
      "reason": "ARCHIVED",
      "type": "asset"
    }
  ]
}

Add user to group

Add a person to a user group, so they get the group's content.

Inputs

User groupuser_group_idtextRequired
The user group. Pick one, or give its ID from an earlier step.
Usershowpad_user_idtextRequired
The Showpad user. Pick one, or give their ID from an earlier step.

Outputs

addedtrue/false
Always true once added
showpad_user_idtext
The user added
user_group_idtext
The user group
Example output
{
  "added": true,
  "showpad_user_id": "c143c05d12c1433ba1358c7eb2e07c75",
  "user_group_id": "3f7a2c9e1b4d4e8f9a0b1c2d3e4f5a6b"
}

Create share

Create a share: a trackable link to one or more assets to send a buyer. Showpad records each time it is viewed.

Inputs

TitletitletextRequired
What the buyer sees as the share's title.
Assetsasset_idslistRequired
The assets to share.
Expiresexpires_atdate and time
When the link stops working.
Allow downloadallow_downloadtext
Whether the buyer can download the files.One of: true (Yes), false (No).
Themetheme_idtext
The look of the share.

Outputs

shareobject
The share
Example output
{
  "share": {
    "anonymousUrl": "https://showpad.com/anonymous-share",
    "assets": [
      {
        "id": "5a1b013f3c84478889b1b26fecb7d58d",
        "page": 1
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "dynamicUrl": "https://showpad.com/dynamic-share",
    "expiresAt": "2021-08-24T14:15:22Z",
    "id": "9c5f3aa0784df25db1db821354e337e9",
    "isDownloadAllowed": true,
    "origin": "Lodol",
    "theme": {
      "id": "4d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a"
    },
    "title": "Customer X, Q3 Sales Material",
    "untrackedUrl": "https://showpad.com/untracked-share"
  }
}

Create Shared Space

Create a Shared Space for a buyer, from scratch or from a template. Send them its public_url, or add content first with 'Add assets to Shared Space'.

Inputs

Titletitletext
Its title. Needed unless you start from a template.
Templatetemplate_idtext
A Shared Space template to start from.
Ownerowner_idtext
Who owns it. Leave empty for the person whose token this is.
Descriptiondescriptiontext
A welcome message or summary for the buyer.
Address endingpublic_uritext
The end of its address, in lowercase letters, digits, - and _. Leave empty for a random one.
Themetheme_idtext
The look of the Shared Space.
Accessaccess_typetext
Who can get in. New Shared Spaces are private.One of: PRIVATE_EMAIL_VERIFIED (Private: people you invite sign in), PUBLIC_EMAIL_REQUIRED (Public: anyone with the link gives an email).
Commentsallow_commentstext
Whether people can comment.One of: true (Yes), false (No).
Buyers can uploadallow_external_uploadtext
Whether buyers can upload files.One of: true (Yes), false (No).
Buyers can inviteallow_external_invitetext
Whether buyers can invite other people.One of: true (Yes), false (No).
Buyers can downloadallow_external_downloadtext
Whether buyers can download the content.One of: true (Yes), false (No).

Outputs

shared_spaceobject
The Shared Space
Example output
{
  "shared_space": {
    "accessType": "PRIVATE_EMAIL_VERIFIED",
    "archivedAt": "",
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "Everything we discussed in our call",
    "id": "9c5f3aa0784df25db1db821354e337e9",
    "isCommentAllowed": true,
    "isExternalDownloadAllowed": true,
    "isExternalInviteAllowed": true,
    "isExternalUploadAllowed": false,
    "isSearchAIAllowed": true,
    "lastActivityAt": "2019-08-24T14:15:22Z",
    "owner": {
      "userId": "c143c05d12c1433ba1358c7eb2e07c75"
    },
    "publicUri": "nice-shared-space",
    "publicUrl": "https://example.showpad.biz/s/nice-shared-space",
    "status": "ACTIVE",
    "theme": {
      "id": "4d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a"
    },
    "title": "Sales and Marketing teams",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Create tag

Create a tag in a Division, to label assets with.

Inputs

NamenametextRequired
The tag's name.
Divisiondivision_idtextRequired
The Division the tag belongs to.

Outputs

tagobject
A tag
Example output
{
  "tag": {
    "createdAt": "2021-01-01T00:00:00Z",
    "division": {
      "id": "f541710283954a89bdfd40f221882451"
    },
    "id": "df391e1da6ed4db8a8085838f7abd130",
    "isDivisionShared": false,
    "name": "TagA",
    "tagCategories": [
      {
        "id": "0c2d2a4e7f3b4c5d8e9f0a1b2c3d4e5f"
      }
    ],
    "updatedAt": "2021-01-01T08:00:00Z"
  }
}

Create user group

Create a user group, to give a set of people the same content.

Inputs

NamenametextRequired
The group's name.
Descriptiondescriptiontext
What the group is for.
External IDexternal_idtext
Your own ID for the group, such as its ID in your HR system.

Outputs

user_groupobject
A user group
Example output
{
  "user_group": {
    "createdAt": "2024-02-01T09:00:00+00:00",
    "description": "Sellers in Europe, the Middle East and Africa",
    "externalId": "emea-sales",
    "id": "3f7a2c9e1b4d4e8f9a0b1c2d3e4f5a6b",
    "isDefault": false,
    "isSynced": false,
    "name": "EMEA Sales",
    "updatedAt": "2024-02-01T09:00:00+00:00",
    "userCount": 0
  }
}

Delete asset

Delete an asset from the library for good. It can't be recovered.

Inputs

Assetasset_idtextRequired
The asset. Pick one, or give its ID from an earlier step.

Outputs

asset_idtext
The asset deleted
deletedtrue/false
Always true once deleted
Example output
{
  "asset_id": "5a1b013f3c84478889b1b26fecb7d58d",
  "deleted": true
}

Delete Shared Space

Delete a Shared Space for good. Buyers can no longer open it.

Inputs

Shared Spaceshared_space_idtextRequired
The Shared Space. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
shared_space_idtext
The Shared Space deleted
Example output
{
  "deleted": true,
  "shared_space_id": "9c5f3aa0784df25db1db821354e337e9"
}

Delete tag

Delete a tag. It comes off every asset that had it.

Inputs

Tagtag_idtextRequired
The tag. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
tag_idtext
The tag deleted
Example output
{
  "deleted": true,
  "tag_id": "df391e1da6ed4db8a8085838f7abd130"
}

Delete user group

Delete a user group. Its people stay in Showpad but lose what the group gave them.

Inputs

User groupuser_group_idtextRequired
The user group. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
user_group_idtext
The user group deleted
Example output
{
  "deleted": true,
  "user_group_id": "3f7a2c9e1b4d4e8f9a0b1c2d3e4f5a6b"
}

Export events

Export activity behind Showpad's reports: views, downloads, shares and Shared Space visits, with who and what was involved.

Inputs

Event typesevent_typeslist
Only these kinds of event. Leave empty for all.One or more of: share-created (Share created), share-email-opened (Share email opened), share-viewed (Share viewed), share-reshared (Share forwarded), shared-asset-viewed (Shared asset viewed), shared-asset-downloaded (Shared asset downloaded), asset-shared (Asset shared), asset-in-app-viewed (Asset viewed in the app), asset-in-app-downloaded (Asset downloaded in the app), sharedspace-created (Shared Space created), and 8 more.
Fromstarted_afterdate and time
Only events that happened after this time.
Untilstarted_beforedate and time
Only events that happened before this time.
Received sincelogged_afterdate and time
Only events Showpad received after this time, including ones the app recorded offline earlier.
Usershowpad_user_idtext
Only this person's events.
How manylimitnumber
How many to return, 50 to 1000. Showpad's default is 500.From 50 to 1000.

Outputs

countnumber
How many came back
eventslist
The events
Example output
{
  "count": 1,
  "events": [
    {
      "assetId": "3b6d75cf1970aa5f1a3e6bf73cd07347",
      "channelId": "",
      "contactId": "a26c59efde808da3b54085f3df0042cd",
      "divisionId": "",
      "endTime": "2018-04-05T13:54:19+00:00",
      "eventId": "92d93d74bb1017d71533f8b6335fdb25152685c473a851890597c2a521f161f2",
      "loggedAt": "2018-04-05T13:54:19+00:00",
      "shareId": "64cd098838b373928d45623ffd893baa",
      "sharedSpaceId": "",
      "startTime": "2018-04-05T13:54:17+00:00",
      "type": "shared-asset-viewed",
      "userId": "c0bf28fe5aefb7cf3b8091c71a8bc4c9"
    }
  ]
}

Find assets

Find assets in the Showpad library by name, type, status, Division, tags or when they were added or changed. Archived assets are left out unless you ask for them.

Inputs

Name containsname_containstext
Only assets whose name contains this, 2 to 64 characters.
Typeasset_typetext
Only assets of this type.One of: document, photo, video, audio, url (Web link), page, webapp (Web app), 3d-model (3D model), scorm (SCORM course), personal-video-recording (Personal video recording), raw (Other file).
Statusstatustext
Only assets in this state.One of: active, processing, queued, prepared (Waiting for its file), failed.
Divisionsdivision_idslist
Only assets in these Divisions.
Tagstag_idslist
Only assets with at least one of these tags.
Added sincecreated_afterdate and time
Only assets added on or after this time.
Changed sinceupdated_afterdate and time
Only assets changed on or after this time.
Include archivedinclude_archivedtext
Whether to include archived assets. Left out unless Yes.One of: true (Yes), false (No).
More conditions (ShowQL)showqltext
Extra conditions in Showpad's query language, added with AND, such as pageCount > 10 or countries ~ "US".
Ordersorttext
How to order the assets. Showpad's default is oldest first.One of: createdAt DESC (Newest first), createdAt ASC (Oldest first), updatedAt DESC (Recently changed first), lastUploadedAt DESC (Recently uploaded first), name ASC (Name, A to Z).
How manylimitnumber
How many to return, 1 to 100. Showpad's default is 20.From 1 to 100.
Next pagecursortext
The next_cursor from an earlier run, for the page after it.

Outputs

assetslist
The assets found
countnumber
How many assets match in all
next_cursortext
Give this as Next page for more; empty on the last page
querytext
The ShowQL query that was run
Example output
{
  "assets": [
    {
      "authors": [
        {
          "id": "83a5a807b3c487c91f39d1c3da00b5d6"
        }
      ],
      "checksum": "5633b7f75c44f76f0b3f97e73f529cf6",
      "countries": [
        {
          "code": "US"
        }
      ],
      "createdAt": "2023-04-18T12:00:00Z",
      "currentFile": {
        "id": "1d5bd771a4a0e9e2b32b59440f19683c"
      },
      "description": "The most flexible & complete operating system",
      "division": {
        "id": "f541710283954a89bdfd40f221882451"
      },
      "expiresAt": "2024-04-18T12:00:00Z",
      "externalId": "my-custom-id",
      "id": "5a1b013f3c84478889b1b26fecb7d58d",
      "isArchived": false,
      "isDivisionShared": false,
      "isSensitive": false,
      "languages": [
        {
          "code": "en"
        }
      ],
      "lastUploadedAt": "2023-04-18T12:02:36Z",
      "name": "eOS.pdf",
      "pageCount": 5,
      "permissions": {
        "isAnnotatable": false,
        "isEditable": false,
        "isShareable": true
      },
      "releasedAt": "2023-04-18T12:00:00Z",
      "size": 1800531,
      "slug": "eos-pdf",
      "status": "active",
      "tags": [
        {
          "id": "df391e1da6ed4db8a8085838f7abd130"
        }
      ],
      "type": "document",
      "updatedAt": "2023-04-18T18:41:00Z",
      "url": ""
    }
  ],
  "count": 1,
  "next_cursor": "",
  "query": "type = \"document\" AND archivedAt IS EMPTY"
}

Get asset

Get one asset with its details: type, status, Division, tags, languages, countries and dates.

Inputs

Assetasset_idtextRequired
The asset. Pick one, or give its ID from an earlier step.

Outputs

assetobject
The asset
Example output
{
  "asset": {
    "authors": [
      {
        "id": "83a5a807b3c487c91f39d1c3da00b5d6"
      }
    ],
    "checksum": "5633b7f75c44f76f0b3f97e73f529cf6",
    "countries": [
      {
        "code": "US"
      }
    ],
    "createdAt": "2023-04-18T12:00:00Z",
    "currentFile": {
      "id": "1d5bd771a4a0e9e2b32b59440f19683c"
    },
    "description": "The most flexible & complete operating system",
    "division": {
      "id": "f541710283954a89bdfd40f221882451"
    },
    "expiresAt": "2024-04-18T12:00:00Z",
    "externalId": "my-custom-id",
    "id": "5a1b013f3c84478889b1b26fecb7d58d",
    "isArchived": false,
    "isDivisionShared": false,
    "isSensitive": false,
    "languages": [
      {
        "code": "en"
      }
    ],
    "lastUploadedAt": "2023-04-18T12:02:36Z",
    "name": "eOS.pdf",
    "pageCount": 5,
    "permissions": {
      "isAnnotatable": false,
      "isEditable": false,
      "isShareable": true
    },
    "releasedAt": "2023-04-18T12:00:00Z",
    "size": 1800531,
    "slug": "eos-pdf",
    "status": "active",
    "tags": [
      {
        "id": "df391e1da6ed4db8a8085838f7abd130"
      }
    ],
    "type": "document",
    "updatedAt": "2023-04-18T18:41:00Z",
    "url": ""
  }
}

Get Shared Space

Get one Shared Space with its address, owner, settings and when someone was last active in it.

Inputs

Shared Spaceshared_space_idtextRequired
The Shared Space. Pick one, or give its ID from an earlier step.

Outputs

shared_spaceobject
The Shared Space
Example output
{
  "shared_space": {
    "accessType": "PRIVATE_EMAIL_VERIFIED",
    "archivedAt": "",
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "Everything we discussed in our call",
    "id": "9c5f3aa0784df25db1db821354e337e9",
    "isCommentAllowed": true,
    "isExternalDownloadAllowed": true,
    "isExternalInviteAllowed": true,
    "isExternalUploadAllowed": false,
    "isSearchAIAllowed": true,
    "lastActivityAt": "2019-08-24T14:15:22Z",
    "owner": {
      "userId": "c143c05d12c1433ba1358c7eb2e07c75"
    },
    "publicUri": "nice-shared-space",
    "publicUrl": "https://example.showpad.biz/s/nice-shared-space",
    "status": "ACTIVE",
    "theme": {
      "id": "4d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a"
    },
    "title": "Sales and Marketing teams",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

List Divisions

List the Divisions (separate content libraries) in your Showpad.

Inputs

How manylimitnumber
How many to return, 1 to 1000. Showpad's default is 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page.At least 0.

Outputs

countnumber
How many came back
divisionslist
The Divisions
Example output
{
  "count": 1,
  "divisions": [
    {
      "createdAt": "2021-01-01T00:00:00Z",
      "id": "f541710283954a89bdfd40f221882451",
      "isAssetSharingEnabled": true,
      "name": "My Global Division",
      "updatedAt": "2021-01-01T08:00:00Z"
    }
  ]
}

List Experiences

List the Experiences (the branded content portals sellers open in the Showpad app).

Inputs

Namenametext
Only the Experience with this name.
How manylimitnumber
How many to return, 1 to 1000. Showpad's default is 100.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page.At least 0.

Outputs

countnumber
How many came back
experienceslist
The Experiences
Example output
{
  "count": 1,
  "experiences": [
    {
      "createdAt": "2023-06-01T09:00:00+00:00",
      "description": "Everything sellers show in a first meeting",
      "externalId": "",
      "id": "7b1e5d2f8a9c4b3e6d0f1a2b3c4d5e6f",
      "isHidden": false,
      "isPersonal": false,
      "name": "Product Catalog",
      "status": "published",
      "template": "",
      "type": "classic",
      "updatedAt": "2024-03-01T09:00:00+00:00"
    }
  ]
}

List Shared Spaces

List Shared Spaces (the pages you share content and talk with buyers in), by status, title, owner or recent activity.

Inputs

Statusstatustext
Only Shared Spaces in this state. Leave empty for both.One of: ACTIVE, ARCHIVED.
Title containstitletext
Only Shared Spaces whose title contains this.
Ownerowner_idtext
Only Shared Spaces this person owns.
Active sincelast_activity_sincedate and time
Only Shared Spaces someone did something in since then.
Ordersorttext
How to order them.One of: -createdAt (Newest first), createdAt (Oldest first), -lastActivityAt (Most recent activity first), -updatedAt (Recently changed first), title (Title, A to Z).
How manylimitnumber
How many to return, 1 to 1000. Showpad's default is 1000.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page.At least 0.

Outputs

countnumber
How many came back
shared_spaceslist
The Shared Spaces
Example output
{
  "count": 1,
  "shared_spaces": [
    {
      "accessType": "PRIVATE_EMAIL_VERIFIED",
      "archivedAt": "",
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "Everything we discussed in our call",
      "id": "9c5f3aa0784df25db1db821354e337e9",
      "isCommentAllowed": true,
      "isExternalDownloadAllowed": true,
      "isExternalInviteAllowed": true,
      "isExternalUploadAllowed": false,
      "isSearchAIAllowed": true,
      "lastActivityAt": "2019-08-24T14:15:22Z",
      "owner": {
        "userId": "c143c05d12c1433ba1358c7eb2e07c75"
      },
      "publicUri": "nice-shared-space",
      "publicUrl": "https://example.showpad.biz/s/nice-shared-space",
      "status": "ACTIVE",
      "theme": {
        "id": "4d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a"
      },
      "title": "Sales and Marketing teams",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

List tags

List the tags used to label assets, optionally in one Division or matching a name.

Inputs

Divisiondivision_idtext
Only tags in this Division.
Name containsnametext
Only tags whose name contains this.
How manylimitnumber
How many to return, 1 to 1000. Showpad's default is 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page.At least 0.

Outputs

countnumber
How many came back
tagslist
The tags
Example output
{
  "count": 1,
  "tags": [
    {
      "createdAt": "2021-01-01T00:00:00Z",
      "division": {
        "id": "f541710283954a89bdfd40f221882451"
      },
      "id": "df391e1da6ed4db8a8085838f7abd130",
      "isDivisionShared": false,
      "name": "TagA",
      "tagCategories": [
        {
          "id": "0c2d2a4e7f3b4c5d8e9f0a1b2c3d4e5f"
        }
      ],
      "updatedAt": "2021-01-01T08:00:00Z"
    }
  ]
}

List user groups

List the user groups that decide who sees which content.

Inputs

Namenametext
Only the group with this name.
How manylimitnumber
How many to return, 1 to 1000. Showpad's default is 100.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page.At least 0.

Outputs

countnumber
How many came back
user_groupslist
The user groups
Example output
{
  "count": 1,
  "user_groups": [
    {
      "createdAt": "2024-02-01T09:00:00+00:00",
      "description": "Sellers in Europe, the Middle East and Africa",
      "externalId": "emea-sales",
      "id": "3f7a2c9e1b4d4e8f9a0b1c2d3e4f5a6b",
      "isDefault": false,
      "isSynced": false,
      "name": "EMEA Sales",
      "updatedAt": "2024-02-01T09:00:00+00:00",
      "userCount": 12
    }
  ]
}

List users

List the people in your Showpad, or find them by email.

Inputs

Emailsemailstext
Only these people: one or more emails, separated by commas.
How manylimitnumber
How many to return, 1 to 1000. Showpad's default is 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page.At least 0.

Outputs

countnumber
How many came back
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "createdAt": "2021-01-01T00:00:00Z",
      "email": "bob.smith@example.com",
      "firstName": "Bob",
      "id": "c143c05d12c1433ba1358c7eb2e07c75",
      "lastName": "Smith",
      "updatedAt": "2021-01-01T08:00:00Z"
    }
  ]
}

Remove user from group

Take a person out of a user group. They stay in Showpad.

Inputs

User groupuser_group_idtextRequired
The user group. Pick one, or give its ID from an earlier step.
Usershowpad_user_idtextRequired
The Showpad user. Pick one, or give their ID from an earlier step.

Outputs

removedtrue/false
Always true once removed
showpad_user_idtext
The user removed
user_group_idtext
The user group
Example output
{
  "removed": true,
  "showpad_user_id": "c143c05d12c1433ba1358c7eb2e07c75",
  "user_group_id": "3f7a2c9e1b4d4e8f9a0b1c2d3e4f5a6b"
}

Update asset

Change an asset's name, description, tags, dates or sharing, or archive it. Fields left empty stay as they are.

Inputs

Assetasset_idtextRequired
The asset. Pick one, or give its ID from an earlier step.
Namenametext
A new name.
Descriptiondescriptiontext
What the asset is, shown in the library.
External IDexternal_idtext
Your own ID for the asset, such as its ID in your CMS.
Tagstag_idslist
The asset's tags become exactly these.
Expiresexpires_atdate and time
When the asset stops being available to sellers.
Releasedreleased_atdate and time
When the asset becomes available to sellers.
Can be sharedis_shareabletext
Whether sellers may share the asset with buyers.One of: true (Yes), false (No).
Archivedis_archivedtext
Yes to archive it, No to restore it.One of: true (Yes), false (No).

Outputs

assetobject
The asset
Example output
{
  "asset": {
    "authors": [
      {
        "id": "83a5a807b3c487c91f39d1c3da00b5d6"
      }
    ],
    "checksum": "5633b7f75c44f76f0b3f97e73f529cf6",
    "countries": [
      {
        "code": "US"
      }
    ],
    "createdAt": "2023-04-18T12:00:00Z",
    "currentFile": {
      "id": "1d5bd771a4a0e9e2b32b59440f19683c"
    },
    "description": "The most flexible & complete operating system",
    "division": {
      "id": "f541710283954a89bdfd40f221882451"
    },
    "expiresAt": "2024-04-18T12:00:00Z",
    "externalId": "my-custom-id",
    "id": "5a1b013f3c84478889b1b26fecb7d58d",
    "isArchived": false,
    "isDivisionShared": false,
    "isSensitive": false,
    "languages": [
      {
        "code": "en"
      }
    ],
    "lastUploadedAt": "2023-04-18T12:02:36Z",
    "name": "eOS.pdf",
    "pageCount": 5,
    "permissions": {
      "isAnnotatable": false,
      "isEditable": false,
      "isShareable": true
    },
    "releasedAt": "2023-04-18T12:00:00Z",
    "size": 1800531,
    "slug": "eos-pdf",
    "status": "active",
    "tags": [
      {
        "id": "df391e1da6ed4db8a8085838f7abd130"
      }
    ],
    "type": "document",
    "updatedAt": "2023-04-18T18:41:00Z",
    "url": ""
  }
}

Update Shared Space

Change a Shared Space's title, description or settings, or archive it. Fields left empty stay as they are.

Inputs

Shared Spaceshared_space_idtextRequired
The Shared Space. Pick one, or give its ID from an earlier step.
Titletitletext
A new title.
Descriptiondescriptiontext
A new description.
Statusstatustext
Archived to archive it, Active to bring it back.One of: ACTIVE, ARCHIVED.
Themetheme_idtext
The look of the Shared Space.
Accessaccess_typetext
Who can get in. New Shared Spaces are private.One of: PRIVATE_EMAIL_VERIFIED (Private: people you invite sign in), PUBLIC_EMAIL_REQUIRED (Public: anyone with the link gives an email).
Commentsallow_commentstext
Whether people can comment.One of: true (Yes), false (No).
Buyers can uploadallow_external_uploadtext
Whether buyers can upload files.One of: true (Yes), false (No).
Buyers can inviteallow_external_invitetext
Whether buyers can invite other people.One of: true (Yes), false (No).
Buyers can downloadallow_external_downloadtext
Whether buyers can download the content.One of: true (Yes), false (No).

Outputs

shared_spaceobject
The Shared Space
Example output
{
  "shared_space": {
    "accessType": "PRIVATE_EMAIL_VERIFIED",
    "archivedAt": "",
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "Everything we discussed in our call",
    "id": "9c5f3aa0784df25db1db821354e337e9",
    "isCommentAllowed": true,
    "isExternalDownloadAllowed": true,
    "isExternalInviteAllowed": true,
    "isExternalUploadAllowed": false,
    "isSearchAIAllowed": true,
    "lastActivityAt": "2019-08-24T14:15:22Z",
    "owner": {
      "userId": "c143c05d12c1433ba1358c7eb2e07c75"
    },
    "publicUri": "nice-shared-space",
    "publicUrl": "https://example.showpad.biz/s/nice-shared-space",
    "status": "ACTIVE",
    "theme": {
      "id": "4d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a"
    },
    "title": "Sales and Marketing teams",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Upload asset

Add a file to the Showpad library as a new asset in a Division. Showpad then processes it, which can take a few minutes for a large file.

Inputs

FilefiletextRequired
The file: upload one, pick a file from an earlier step, or give an https:// link to it. Up to 100 MB.
Divisiondivision_idtextRequired
The Division (library) to put the asset in.
Namenametext
The asset's name. Leave empty to use the file name.
Descriptiondescriptiontext
What the asset is, shown in the library.
External IDexternal_idtext
Your own ID for the asset, such as its ID in your CMS.
Tagstag_idslist
Tags to put on the asset.
Expiresexpires_atdate and time
When the asset stops being available to sellers.
Releasedreleased_atdate and time
When the asset becomes available to sellers.
Can be sharedis_shareabletext
Whether sellers may share the asset with buyers.One of: true (Yes), false (No).

Outputs

assetobject
The asset
fileobject
The uploaded file
Example output
{
  "asset": {
    "authors": [
      {
        "id": "83a5a807b3c487c91f39d1c3da00b5d6"
      }
    ],
    "checksum": "5633b7f75c44f76f0b3f97e73f529cf6",
    "countries": [
      {
        "code": "US"
      }
    ],
    "createdAt": "2023-04-18T12:00:00Z",
    "currentFile": {
      "id": "1d5bd771a4a0e9e2b32b59440f19683c"
    },
    "description": "The most flexible & complete operating system",
    "division": {
      "id": "f541710283954a89bdfd40f221882451"
    },
    "expiresAt": "2024-04-18T12:00:00Z",
    "externalId": "my-custom-id",
    "id": "5a1b013f3c84478889b1b26fecb7d58d",
    "isArchived": false,
    "isDivisionShared": false,
    "isSensitive": false,
    "languages": [
      {
        "code": "en"
      }
    ],
    "lastUploadedAt": "2023-04-18T12:02:36Z",
    "name": "eOS.pdf",
    "pageCount": 5,
    "permissions": {
      "isAnnotatable": false,
      "isEditable": false,
      "isShareable": true
    },
    "releasedAt": "2023-04-18T12:00:00Z",
    "size": 1800531,
    "slug": "eos-pdf",
    "status": "prepared",
    "tags": [
      {
        "id": "df391e1da6ed4db8a8085838f7abd130"
      }
    ],
    "type": "document",
    "updatedAt": "2023-04-18T18:41:00Z",
    "url": ""
  },
  "file": {
    "createdAt": "2023-04-18T12:00:00Z",
    "id": "my-asset-file-id",
    "name": "eOS.pdf",
    "status": "prepared",
    "updatedAt": "2023-04-18T12:00:00Z"
  }
}

Upload new asset version

Replace an asset's file with a new version. Its name, tags and everywhere it is used stay the same.

Inputs

Assetasset_idtextRequired
The asset. Pick one, or give its ID from an earlier step.
FilefiletextRequired
The file: upload one, pick a file from an earlier step, or give an https:// link to it. Up to 100 MB.

Outputs

asset_idtext
The asset given the new version
fileobject
The uploaded file
Example output
{
  "asset_id": "5a1b013f3c84478889b1b26fecb7d58d",
  "file": {
    "createdAt": "2023-04-18T12:00:00Z",
    "id": "my-asset-file-id",
    "name": "eOS.pdf",
    "status": "prepared",
    "updatedAt": "2023-04-18T12:00:00Z"
  }
}

On this page