PUT
/
workspaces
/
{id}
Updates a workspaces
curl --request PUT \
  --url https://core.ravenna.ai/api/workspaces/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "name": "<string>",
  "slug": "<string>",
  "color": "tomato",
  "private": true,
  "defaultQueueId": "<string>",
  "slackBotUsername": "<string>",
  "slackBotIcon": {
    "base64": "<string>",
    "fileName": "<string>"
  },
  "slackEmojiActions": {
    "connect_new_queue": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "connect_existing_queue": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "connect_triage_channel": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "create_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "create_ticket_form_qna": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "submit_request": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "show_request_types": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "edit_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "assign_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "assign_to_me": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "approve_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "decline_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "follow_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "unfollow_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "edit_tags": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "set_priority": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "set_status": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "view_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "view_thread": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "resolve_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "close_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "reopen_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "create_private_channel": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "agent_feedback_yes": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "agent_feedback_no": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "kb_suggested_response_send": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "kb_suggested_response_dismiss": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "kb_no_answer_create_ticket": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "list_my_tickets": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "list_open_tickets": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "kb_no_answer_dismiss": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "suggest_response": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "dismiss": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "generate_knowledge": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "run_ai_pipeline": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "stop_automated_responses": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "create_new_ticket_and_private_channel": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "csat_1": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "csat_2": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "csat_3": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "csat_4": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "csat_5": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "ravenna_agent_input": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "help_tickets": {
      "native": "<string>",
      "shortcode": "<string>"
    },
    "help_channel": {
      "native": "<string>",
      "shortcode": "<string>"
    }
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "organizationId": "<string>",
  "creatorId": "<string>",
  "private": true,
  "color": "tomato",
  "slackBotIconUrl": "<string>",
  "slackBotUsername": "<string>",
  "slackEmojiActions": "<any>",
  "defaultQueueId": "<string>",
  "slackTriageChannels": [
    {
      "workspace": {
        "id": "<string>",
        "name": "<string>"
      },
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "private": true,
      "deletedAt": "<string>",
      "type": "DM",
      "channelId": "<string>",
      "channelName": "<string>",
      "mirrorTs": "<string>",
      "appId": "<string>",
      "workspaceId": "<string>",
      "queue": {
        "id": "<string>",
        "name": "<string>",
        "emoji": "<string>",
        "workspaceId": "<string>"
      },
      "queueId": "<string>",
      "agentId": "<string>",
      "slackUserId": "<string>",
      "userId": "<string>",
      "ticketId": "<string>",
      "contextTeamId": "<string>",
      "app": {
        "id": "<string>",
        "appId": "<string>",
        "accessToken": "<string>",
        "refreshToken": "<string>",
        "error": "<string>",
        "expiresIn": 123,
        "expiresAt": "<string>",
        "authedUserId": "<string>",
        "botUserId": "<string>",
        "teamId": "<string>",
        "teamName": "<string>",
        "teamDomain": "<string>",
        "channelName": "<string>",
        "channelId": "<string>",
        "teamUrl": "<string>",
        "organizationId": "<string>",
        "enterpriseId": "<string>",
        "enterpriseName": "<string>",
        "isEnterpriseInstall": true,
        "workflowsAppId": "<string>",
        "workflowsAppSigningSecret": "<string>",
        "agentWorkspaceId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  ],
  "activePersonality": {
    "id": "<string>",
    "workspaceId": "<string>",
    "persona": "<string>",
    "tone": "<string>",
    "emoji": "<string>",
    "length": "<string>",
    "greeting": "<string>",
    "branding": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "settings": {
    "id": "<string>",
    "ticketAssigneeScope": "<string>",
    "disableSlackUserSync": true
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Path Parameters

id
string
required

Body

application/json
name
string
slug
string
color
enum<string> | null
Available options:
tomato,
red,
ruby,
crimson,
pink,
plum,
purple,
violet,
iris,
indigo,
blue,
cyan,
teal,
jade,
green,
grass,
brown,
orange,
sky,
mint,
lime,
yellow,
amber,
gold,
bronze,
gray
private
boolean
defaultQueueId
string | null
slackBotUsername
string | null
slackBotIcon
object
slackEmojiActions
object

Response

Successful response

id
string
required
name
string
required
slug
string
required
organizationId
string
required
creatorId
string
required
private
boolean
required
color
enum<string> | null
required
Available options:
tomato,
red,
ruby,
crimson,
pink,
plum,
purple,
violet,
iris,
indigo,
blue,
cyan,
teal,
jade,
green,
grass,
brown,
orange,
sky,
mint,
lime,
yellow,
amber,
gold,
bronze,
gray
slackBotIconUrl
string | null
required
slackBotUsername
string | null
required
defaultQueueId
string | null
required
slackTriageChannels
object[]
required
activePersonality
object | null
required
settings
object | null
required
createdAt
string
required
updatedAt
string
required
deletedAt
string | null
required
slackEmojiActions
any