Create a team

POST /v2/teams

Try it

Create a team

cURL

curl --request POST \
  --url https://b2b-api.dev-riseworks.io/v2/teams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "company_nanoid": "<string>",
  "admins": [
    {
      "nanoid": "<string>",
      "type": "team_admin"
    }
  ],
  "withdraw_fee_coverage": true,
  "avatar_file_name": "<string>"
}
'

200

{
  "success": true,
  "data": {
    "name": "<string>",
    "nanoid": "<string>",
    "avatar": "<string>"
  }
}

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

Name of the team, must be at least 1 character long and trimmed

Minimum string length: 1

company_nanoid · string · required

Unique identifier for the company in nanoid format

Required string length: 15

admins · object[] · required

Show child attributes

admins. nanoid · string · required

Unique identifier for the admin user in nanoid format

Required string length: 15

admins. type · enum<string> · required

Role type of the admin within the team, can be team_admin, team_finance_admin, or team_viewer

Available options: team_admin, team_finance_admin, team_viewer

withdraw_fee_coverage · boolean · required

Indicates whether the team covers withdrawal fees

avatar_file_name · string

Optional filename for the team avatar

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object · required

Show child attributes

data. name · string · required

Name of the team.

Minimum string length: 1

data. nanoid · string · required

Unique identifier for the team.

data. avatar · string · required

URL of the team avatar.