Skip to content
PAASBOX PAASBOX PAASBOX

teams_partial_update

PATCH
/teams/api/teams/{id}/
 
curl --request PATCH \
  --url https://example.com/teams/api/teams/1/ \
  --header 'Content-Type: application/json' \
  --cookie sessionid=<sessionid> \
  --data '{ "name": "example", "slug": "example" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
integer

A unique integer value identifying this team.

Request Body

Section titled “Request Body ”
object
id
integer
name
string
<= 100 characters
slug
string
/^[-a-zA-Z0-9_]+$/
members
Array<object>
object
id
required
integer
user_id
required
integer
first_name
required
string
last_name
required
string
display_name
required
string
role
required
  • admin - Administrator
  • member - Member
string
Allowed values: admin member
invitations
Array<object>
object
id
required
string format: uuid
team
required
integer
email
required
string format: email
<= 254 characters
role
  • admin - Administrator
  • member - Member
string
Allowed values: admin member
invited_by
required
string
is_accepted
boolean
dashboard_url
string
is_admin
boolean
subscription
object
id
required
string
<= 255 characters
display_name
required
string
start_date
required
string format: date-time
billing_interval
required
string
current_period_start
required
string format: date-time
current_period_end
required
string format: date-time
cancel_at_period_end
required
boolean
status
required
string
quantity
required
integer
items
required
Array<object>
object
id
required
string
<= 255 characters
price
required
object
id
required
string
<= 255 characters
product_name
required
string
human_readable_price
required
string
payment_amount
required
string
nickname

A brief description of the plan, hidden from customers.

string
<= 250 characters
unit_amount
required
integer
quantity
required
integer
has_active_subscription
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”
Media type application/json
object
id
required
integer
name
required
string
<= 100 characters
slug
string
/^[-a-zA-Z0-9_]+$/
members
required
Array<object>
object
id
required
integer
user_id
required
integer
first_name
required
string
last_name
required
string
display_name
required
string
role
required
  • admin - Administrator
  • member - Member
string
Allowed values: admin member
invitations
required
Array<object>
object
id
required
string format: uuid
team
required
integer
email
required
string format: email
<= 254 characters
role
  • admin - Administrator
  • member - Member
string
Allowed values: admin member
invited_by
required
string
is_accepted
boolean
dashboard_url
required
string
is_admin
required
boolean
subscription
required
object
id
required
string
<= 255 characters
display_name
required
string
start_date
required
string format: date-time
billing_interval
required
string
current_period_start
required
string format: date-time
current_period_end
required
string format: date-time
cancel_at_period_end
required
boolean
status
required
string
quantity
required
integer
items
required
Array<object>
object
id
required
string
<= 255 characters
price
required
object
id
required
string
<= 255 characters
product_name
required
string
human_readable_price
required
string
payment_amount
required
string
nickname

A brief description of the plan, hidden from customers.

string
<= 250 characters
unit_amount
required
integer
quantity
required
integer
has_active_subscription
required
boolean
Example 
{
  "members": [
    {
      "role": "admin"
    }
  ],
  "invitations": [
    {
      "role": "admin"
    }
  ]
}