Skip to content

Create a win

POST
/api/v1/wins
curl --request POST \
--url https://example.com/api/v1/wins \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "attachment_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "body": "example", "occurred_on": "2026-04-15", "space_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "tag_names": [ "example" ] }'
Media typeapplication/json
object
attachment_ids
Array<string> | null
body
string | null
occurred_on
required
string format: date
space_id
string | null format: uuid
tag_names

Tag names as an array of strings or one comma-separated string.

One of:
Array<string>

Example generated

{
"attachment_ids": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"body": "example",
"occurred_on": "2026-04-15",
"space_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"tag_names": [
"example"
]
}

Win created

Media typeapplication/json
object
attachments
required
Array<object>
object
byte_size
required
integer format: int64
content_type
required
string
created_at
required
string format: date-time
filename
required
string
id
required
string format: uuid
image
required
boolean
url
required
string format: uri-template
win_id
string | null format: uuid
body
required
string
can_edit
required
boolean
created_at
required
string format: date-time
id
required
string format: uuid
occurred_on
required
string format: date
space
required
object
emoji
string | null
id
required
string format: uuid
name
required
string
tags
required
Array<object>
object
id
required
string format: uuid
name
required
string
updated_at
required
string format: date-time
user_id
required
string format: uuid

Example generated

{
"attachments": [
{
"byte_size": 1,
"content_type": "example",
"created_at": "2026-04-15T12:00:00Z",
"filename": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"image": true,
"url": "example",
"win_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
],
"body": "example",
"can_edit": true,
"created_at": "2026-04-15T12:00:00Z",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"occurred_on": "2026-04-15",
"space": {
"emoji": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example"
},
"tags": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example"
}
],
"updated_at": "2026-04-15T12:00:00Z",
"user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Authentication required

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Plan limit reached

Media typeapplication/json
object
error
required
string
upgrade_url
required
string format: uri

Example generated

{
"error": "example",
"upgrade_url": "https://example.com"
}

Not allowed

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Space not found

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Validation failed

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}