Skip to content
Tasuku

/api/v1/lists/{listId}/members (POST)

POST
/api/v1/lists/{listId}/members
 
curl --request POST \
  --url https://example.com/api/v1/lists/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/members \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
listId
required
string format: uuid

Request Body

Section titled “Request Body ”
Media type application/json
object
email
required
string format: email
Example generated
{
  "email": "hello@example.com"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Already a Member (idempotent)

Media type application/json
object
userId
required
string
displayName
required
string
joinedAt
required
string
Example generated
{
  "userId": "example",
  "displayName": "example",
  "joinedAt": "example"
}

201

Section titled “201 ”

Member added

Media type application/json
object
userId
required
string
displayName
required
string
joinedAt
required
string
Example generated
{
  "userId": "example",
  "displayName": "example",
  "joinedAt": "example"
}

401

Section titled “401 ”

No valid session

Media type application/problem+json
object
type
required
string
title
required
string
status
required
number
code
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example"
}

404

Section titled “404 ”

List not found or not owned

Media type application/problem+json
object
type
required
string
title
required
string
status
required
number
code
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example"
}

422

Section titled “422 ”

Not shareable (generic) / self-share

Media type application/problem+json
object
type
required
string
title
required
string
status
required
number
code
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example"
}