Skip to main content
POST
/
sites
Create a new site
curl --request POST \
  --url https://api.usefathom.com/v1/sites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "sharing": "none",
  "share_password": "<string>"
}
'
{
  "id": "CDBUGS",
  "object": "site",
  "name": "Bugs Bunny Portfolio",
  "sharing": "none",
  "created_at": "2023-11-07T05:31:56Z"
}
Create a site

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The name of the website. Any string (up to 255 characters) is acceptable, and it doesn't have to match the website URL

​
sharing
enum<string>

The sharing configuration. Supported values are: none, private or public.

Available options:
none,
private,
public
​
share_password
string

When sharing is set to private, you must also send a password to access the site with.

Response

200 - application/json

Site created

​
id
string
required
Example:

"CDBUGS"

​
object
enum<string>
required
Available options:
site
​
name
string
required
Example:

"Bugs Bunny Portfolio"

​
sharing
enum<string>
required
Available options:
none,
private,
public
​
created_at
string<date-time>
required