--- updatedAt: 2026-05-27T11:11:21.000Z agentTools: projectIndex: https://developers.sedna.com/llms.txt --- # /2019-01-01/team/{id} Update a team Required API Permissions: TEAM_WRITE # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "contact": { "name": "Support", "url": "https://support.sedna.com" }, "termsOfService": "https://www.sedna.com/terms-of-service", "title": "Sedna API", "version": "2019-01-01" }, "servers": [ { "description": "Platform endpoint", "url": "https://{tenant}.sednanetwork.com/platform", "variables": { "tenant": { "default": "example", "description": "Your tenant's unique identifier" } } } ], "security": [ { "Basic": [] }, { "OAuth": [] } ], "paths": { "/2019-01-01/team/{id}": { "patch": { "description": "Update a team\n\nRequired API Permissions: TEAM_WRITE", "operationId": "patchTeam", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamUpdate" } }, "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TeamUpdate" } } } }, "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamSingle" } }, "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TeamSingle" } } }, "description": "default response" } }, "tags": [ "Team API" ] } } }, "components": { "schemas": { "CategoryTagRelData": { "type": "object", "properties": { "id": { "type": "string" }, "messageTag": { "$ref": "#/components/schemas/MessageTag" }, "type": { "type": "string" } } }, "CategoryTagRelLinks": { "type": "object", "properties": { "related": { "type": "string" }, "self": { "type": "string" } } }, "CategoryTagRelToMany": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryTagRelData" } }, "links": { "$ref": "#/components/schemas/CategoryTagRelLinks" } } }, "EventId": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } } }, "MessageTag": { "type": "object", "properties": { "assignedToUserId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "eventId": { "$ref": "#/components/schemas/EventId" }, "messageId": { "type": "string" }, "messageTagId": { "$ref": "#/components/schemas/MessageTagId" }, "removedAt": { "type": "string", "format": "date-time" }, "removedByUserId": { "type": "string" }, "tag": { "$ref": "#/components/schemas/Tag" }, "tagId": { "$ref": "#/components/schemas/TagId" }, "userId": { "type": "string" } } }, "MessageTagId": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } } }, "Tag": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/TagId" }, "name": { "$ref": "#/components/schemas/TagName" }, "tagLabel": { "$ref": "#/components/schemas/TagLabel" }, "tagTypeId": { "type": "integer", "format": "int32" } } }, "TagId": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } } }, "TagLabel": { "type": "object", "properties": { "value": { "type": "string" } } }, "TagName": { "type": "object", "properties": { "value": { "type": "string" } } }, "TeamAttributeAutoBccEmail": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "email" ] }, "TeamAttributes": { "type": "object", "properties": { "additionalEmailAddresses": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean" }, "autoBccEmails": { "type": "array", "items": { "$ref": "#/components/schemas/TeamAttributeAutoBccEmail" } }, "createdAt": { "type": "string", "format": "date-time" }, "disableSend": { "type": "boolean" }, "emailAddress": { "type": "string" }, "emailSignature": { "type": "string" }, "foreignKey": { "type": "string" }, "inboxAssignedToUserId": { "type": "string" }, "internalEmailAddress": { "type": "string" }, "memberCount": { "type": "integer", "format": "int32", "description": "Watched plus default members. Present on administration list responses.", "example": 21 }, "name": { "type": "string" }, "public": { "type": "boolean" }, "purpose": { "type": "string" }, "readOnlyCount": { "type": "integer", "format": "int32", "description": "Auto-archive / not-watched members. Present on administration list responses.", "example": 7 }, "sendingName": { "type": "string" }, "soloInbox": { "type": "boolean" } } }, "TeamLinks": { "type": "object", "properties": { "self": { "type": "string" } } }, "TeamRelationships": { "type": "object", "properties": { "categoryTag": { "$ref": "#/components/schemas/CategoryTagRelToMany" }, "user": { "$ref": "#/components/schemas/UserRelToMany" } } }, "TeamResource": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/TeamAttributes" }, "id": { "type": "string" }, "links": { "$ref": "#/components/schemas/TeamLinks" }, "relationships": { "$ref": "#/components/schemas/TeamRelationships" }, "type": { "type": "string", "description": "the type of the resource", "enum": [ "team" ] }, "uuid": { "type": "string" } } }, "TeamSingle": { "type": "object", "description": "The resource", "properties": { "data": { "$ref": "#/components/schemas/TeamResource" } } }, "TeamUpdate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TeamUpdateResource" } } }, "TeamUpdateAttributes": { "type": "object", "properties": { "additionalEmailAddresses": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean" }, "autoBccEmails": { "type": "array", "items": { "$ref": "#/components/schemas/TeamAttributeAutoBccEmail" } }, "disableSend": { "type": "boolean" }, "emailAddress": { "type": "string" }, "emailSignature": { "type": "string" }, "foreignKey": { "type": "string" }, "inboxAssignedToUserId": { "type": "string" }, "name": { "type": "string" }, "public": { "type": "boolean" }, "purpose": { "type": "string" }, "sendingName": { "type": "string" }, "soloInbox": { "type": "boolean" } } }, "TeamUpdateResource": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/TeamUpdateAttributes" }, "type": { "type": "string", "description": "the type of the resource", "enum": [ "team" ] } } }, "UserRelData": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "UserRelLinks": { "type": "object", "properties": { "related": { "type": "string" }, "self": { "type": "string" } } }, "UserRelToMany": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserRelData" } }, "links": { "$ref": "#/components/schemas/UserRelLinks" } } } }, "securitySchemes": { "Basic": { "description": "The basic auth scheme only requires the API-Specific username/password to be set.", "scheme": "basic", "type": "http" }, "OAuth": { "description": "This API prefers OAuth 2 with client credentials flow. You can create your credentials in the Api Credential Management page.", "flows": { "clientCredentials": { "scopes": { "CATEGORYTAG_DELETE": "Delete category tags", "CATEGORYTAG_READ": "Read category tags", "CATEGORYTAG_WRITE": "Create and update category tags", "CHARTERING_DELETE": "Delete chartering (Pulse) information", "CHARTERING_READ": "Read chartering (Pulse) information", "CHARTERING_WRITE": "Create chartering (Pulse) information", "COMMENT_READ": "Read message comments", "COMPANY_READ": "Read company info", "COMPANY_WRITE": "Update company info (eg. signature)", "CONTACTGROUP_DELETE": "Delete contact groups", "CONTACTGROUP_READ": "Read contact groups", "CONTACTGROUP_WRITE": "Create and update contact groups", "CONTACT_DELETE": "Delete contacts", "CONTACT_READ": "Read contacts", "CONTACT_WRITE": "Create and update contacts", "CRMENTITY_DELETE": "Delete CRM contacts", "CRMENTITY_READ": "Read CRM contacts", "CRMENTITY_WRITE": "Create and update CRM Contacts", "DOCUMENT_READ": "Read and download attachments", "EVENT_READ": "Read events from the events endpoint", "JOBREFERENCE_DELETE": "Delete job references", "JOBREFERENCE_READ": "Read job references", "JOBREFERENCE_WRITE": "Create and update job references", "KEYWORD_DELETE": "Delete custom keywords", "KEYWORD_READ": "Read custom keywords", "KEYWORD_WRITE": "Create and update custom keywords", "LEGAL_HOLD_DELETE": "Delete legal holds", "LEGAL_HOLD_READ": "Read legal holds", "LEGAL_HOLD_WRITE": "Create and update legal holds", "MESSAGE_DELETE": "Archive email messages", "MESSAGE_READ": "Read (draft) email messages", "MESSAGE_RETENTION_SETTINGS_READ": "Read message retention settings", "MESSAGE_RETENTION_SETTINGS_WRITE": "Update message retention settings", "MESSAGE_WRITE": "Create and send (draft) email messages", "PERSONAL_DATA_UNREDACTED_READ": "Read unredacted emails with personal data", "QUARANTINED_MESSAGE_READ": "Read quarantined email messages", "QUARANTINED_MESSAGE_WRITE": "Release quarantined email messages", "RETENTION_POLICY_DELETE": "Delete retention policies", "RETENTION_POLICY_READ": "Read retention policies", "RETENTION_POLICY_WRITE": "Create and update retention policies", "SAVEDSEARCH_DELETE": "Remove saved searches", "SAVEDSEARCH_READ": "Read saved search details", "SAVEDSEARCH_WRITE": "Create and update saved searches", "TEAM_DELETE": "Delete teams", "TEAM_READ": "Read team details", "TEAM_WRITE": "Create and update teams", "TEMPLATE_DELETE": "Delete templates", "TEMPLATE_READ": "Read templates", "TEMPLATE_WRITE": "Create and update templates", "USER_DELETE": "Archive users", "USER_READ": "Read user details", "USER_WRITE": "Create and update users", "WORKFLOW_DELETE": "Delete workflows", "WORKFLOW_READ": "Read workflow details", "WORKFLOW_WRITE": "Create and update workflows" }, "tokenUrl": "https://{tenant}.sednanetwork.com/platform/oauth/token" } }, "type": "oauth2" } } } } ```