Update a team
PATCH {{baseUrl}}/api/v2/team/:team_id
Update a team using the team's id
.
If the team_links
relationship is present, the associated links are updated to be in the order they appear in the array, and any existing team links not present are removed.
Request Body
{"data"=>{"attributes"=>{"handle"=>"<string>", "name"=>"<string>", "avatar"=>"<string>", "banner"=>"<long>", "color"=>"<integer>", "description"=>"<string>", "hidden_modules"=>["<string>", "<string>"], "visible_modules"=>["<string>", "<string>"]}, "type"=>"team", "relationships"=>{"team_links"=>{"data"=>[{"id"=>"<string>", "type"=>"team_links"}, {"id"=>"<string>", "type"=>"team_links"}], "links"=>{"related"=>"<string>"}}}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"attributes":{"handle":"\u003cstring\u003e","name":"\u003cstring\u003e","avatar":"\u003cstring\u003e","banner":"\u003clong\u003e","created_at":"\u003cdateTime\u003e","description":"\u003cstring\u003e","hidden_modules":["\u003cstring\u003e","\u003cstring\u003e"],"link_count":"\u003cinteger\u003e","modified_at":"\u003cdateTime\u003e","summary":"\u003cstring\u003e","user_count":"\u003cinteger\u003e","visible_modules":["\u003cstring\u003e","\u003cstring\u003e"]},"id":"\u003cstring\u003e","type":"team","relationships":{"team_links":{"data":[{"id":"\u003cstring\u003e","type":"team_links"},{"id":"\u003cstring\u003e","type":"team_links"}],"links":{"related":"\u003cstring\u003e"}},"user_team_permissions":{"data":{"id":"\u003cstring\u003e","type":"user_team_permissions"},"links":{"related":"\u003cstring\u003e"}}}}}