Skip to content

createCircle

POST
/circles
curl --request POST \
  --url http://localhost:8080/api/v1/circles \
  --header 'Content-Type: application/json' \
  --cookie hs_session=<hs_session> \
  --data '{ "name": "example", "icon": "example", "color": "terracotta", "visibility": "household", "personIds": [ "per_01j9x3k8m2q4r5s6t7v8w9y0z1" ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 40 characters
icon
string
color
string
Allowed values: terracotta honey sage dusk plum clay
visibility
string
default: household
Allowed values: household private
personIds
Array<string>

Responses

Section titled “Responses”

201

Section titled “201”

Created.

Media typeapplication/json
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
name
required
string
icon
required
string
color
required
string
Allowed values: terracotta honey sage dusk plum clay
visibility
required
string
Allowed values: household private
preset
string | null
Allowed values: family friends creators
personCount
required
integer
people

Present on getCircle only.

Array<object>
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
displayName
required
string
relationLabel
string | null
kind
required
string
Allowed values: family friend creator other
closeness
required

1 = closest. Weights the feed and hearth picks.

integer
>= 1 <= 3
avatar
One of:
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
url
required

Signed URL, valid 24 h.

string
thumbUrl
string
cardUrl
string
posterUrl
string
mime
required
string
width
integer
height
integer
durationMs
integer
blurhash
string
alt
string
inMyFeed
required
boolean
canEdit
required
boolean
sortOrder
required
integer
capturableAccounts

Accounts on platforms the extension can capture.

integer
capturableAccountLimit
integer
Allowed value: 30
lastUpdate
One of:
null

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "canEdit": true,
  "capturableAccountLimit": 30,
  "capturableAccounts": 0,
  "color": "dusk",
  "icon": "users-three",
  "id": "cir_01j9a1b2c3d4e5f6g7h8j9k018",
  "inMyFeed": true,
  "lastUpdate": null,
  "name": "Neighbors",
  "personCount": 0,
  "preset": null,
  "sortOrder": 2,
  "visibility": "household"
}