API Reference
  1. Pencil Spaces API
  2. spaces

Create a Space

post
https://staging-apis.pencilapp.com/public/api/spaces/create

Create a Space

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The title of the Space. If not provided and spaceToCloneId is set, the existing Space name will be used. If not, a random Space name will be generated.

string

The spaceId of the Space you want to clone. You may only clone Spaces that are templates, Spaces for which you are a host, and Spaces which you can access as an admin due to your institution settings.

owner
object

The owner of the Space, who is automatically added as a host. If omitted, the user associated with your API key becomes the owner and is added as a host. To create a Space without adding your generic admin account, pass another user as owner and do not include the admin account in hosts or participants.

hosts
array of objects

The hosts you wish to invite to the Space. The owner is automatically added as a host. The user associated with your API key is automatically added only when owner is omitted; passing another user as owner does not automatically add the API key user.

hosts
participants
array of objects

The participants you wish to invite to the Space.

participants
string
enum
Defaults to public

The default visibility for the Space

Allowed:
boolean
required
Defaults to true

Whether you want to automatically notify invitees when you create your Space

string

The ID of the site linked to the space. This field is required and applicable only for institutions with the sites.

string

The external ID of the Space. External IDs must be unique.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?