PUT /api/teams/{team_id}/
Updates an existing team with a new name.
Servers
- /
Path parameters
Name | Type | Required | Description |
---|---|---|---|
team_id |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
ClientSessionId |
String | No |
An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
name |
String | Yes |
A human friendly name for this team. |
default_role |
String | No |
The uid of the role you want to assign to the team in the given workspace. You can omit this property if you want to remove the role. |
subjects[] |
Array | No |
An array of subject ID/type objects to be used during team create and update. |
subjects[].id |
Integer | Yes | |
subjects[].subject_type |
String | Yes |
The type of subject that is being invited.
Possible values:
|
subjects[].subject_id |
Integer | No |
The subject's unique identifier. |
subjects[].subject_user_email |
String | No |
The user subject's email address. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.