Site

Get list of sites

GET /site/

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation
,
manage:conversation

Request

There are no parameters for this request.

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

SitesResponse

Content typeValue
application/json

SitesResponse is a list of sites.

Get a list of conversations

GET /site/{cloudId}/conversation

The API returns the list of conversations the app has access to

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

Query parameters
include-private

boolean

Include private conversations into response. Default to 'true'.

include-archived

boolean

Include archived conversations into response. Default to 'false'.

limit

integer

A maximum number of conversations to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64
query

string

A string containing full or part of conversation's name. May be empty.

cursor

string

The cursor is a string, that you can use to scroll through the data set to get more results.

sort

string

A sort order of the conversations lists. Supported values: asc or desc.

Pattern: ^(asc|desc)$
exclude-direct

boolean

Exclude direct messages from a response. Default to 'false'

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

GetConversationsListResponse

Content typeValue
application/json

GetConversationsListResponse is a list of non-archived conversations for this cloud.

Create conversation

POST /site/{cloudId}/conversation

Authentication required, with scope manage:conversation

OAuth scopes required
manage:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

Body parameters

CreateConversationRequest is a payload to create a new conversation

name Required

string

The name of the conversation

Min length: 1, Max length: 50
privacy

string

The conversation privacy setting (“public” or “private”). Default value is 'public'

Pattern: (public|private)
topic

string

The conversation topic. May be empty

Example

Copy
1
2
3
4
5
6
7
8
9
10
curl --request POST \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "privacy": "<string>",
  "topic": "<string>"
}'

Responses

CreateConversationResponse returns a successful response for the create conversation api.

Content typeValue
application/json

ConversationID

Get a direct conversation of a user

GET /site/{cloudId}/conversation/user/{userId}

Get a direct conversation of a user.

OAuth scopes required
manage:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

userId Required

string

The user Id

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/user/{userId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

GetConversationDirectResponse

Content typeValue
application/json

GetConversationDirectResponse contains the direct conversation id.

Send message to a user

POST /site/{cloudId}/conversation/user/{userId}/message

Send message to a user.

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

userId Required

string

The user Id

Body parameters
Content typeValue
application/json

string

text/plain

string

text/markdown

string

Example

Copy
1
2
3
4
5
6
curl --request POST \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/user/{userId}/message' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'

Responses

MessageSendResponse is a message send response.

Content typeValue
application/json

MessageID is an object that contains a response with a message id.

Edit a message in a direct conversation

PUT /site/{cloudId}/conversation/user/{userId}/message/{messageId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

userId Required

string

The user Id

messageId Required

string

The ID of the message.

Body parameters
Content typeValue
application/json

string

text/plain

string

Example

Copy
1
2
3
4
5
6
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/user/{userId}/message/{messageId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'

Responses

MessageEditResponse is a message edit response.

Content typeValue
application/json

MessageID is an object that contains a response with a message id.

Delete a message in a direct conversation

DELETE /site/{cloudId}/conversation/user/{userId}/message/{messageId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

userId Required

string

The user Id

messageId Required

string

The ID of the message.

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/user/{userId}/message/{messageId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get conversation details

GET /site/{cloudId}/conversation/{conversationId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Conversation

Content typeValue
application/json

Conversation

Update conversation

PATCH /site/{cloudId}/conversation/{conversationId}

Authentication required, with scope manage:conversation

OAuth scopes required
manage:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Body parameters

ConversationUpdateRequest body for update conversation request

name

string

The conversation name

Min length: 1, Max length: 50
privacy

string

The conversation privacy setting (“public” or “private”)

Pattern: (public|private)
topic

string

The conversation topic

Min length: 1, Max length: 250

Example

Copy
1
2
3
4
5
6
7
8
9
curl --request PATCH \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "privacy": "<string>",
  "topic": "<string>"
}'

Responses

No Content

Get a list of chat:actionTarget modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatActionTargetListResponse

Content typeValue
application/json

ChatActionTargetListResponse

Create or update a chat:actionTarget module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:actionTarget module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get a list of chat:bot modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:bot

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatBotModulesListResponse

Content typeValue
application/json

ChatBotModulesListResponse

Create or update a chat:bot module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:bot/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Body parameters

ChatBotModuleRequest is a payload for chat:bot module

directMessage

ChatBotDirectMessage

ChatBotDirectMessage is the URL where to send 1:1 bot mention events

mention

ChatBotMention

ChatBotMention is the URL where to send bot mention events

Example

Copy
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot/{key}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "directMessage": {
    "url": "<string>"
  },
  "mention": {
    "url": "<string>"
  }
}'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:bot module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:bot/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get a list of chat:bot:messages modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatBotMessagesListResponse

Content typeValue
application/json

ChatBotMessagesListResponse

Create or update a chat:bot:messages module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Body parameters

ChatBotMessagesRequest is the part of the response that describes a particular chat:bot:messages module

pattern

string

Pattern to match messages against (regular expression)

url

string

URL for the endpoint to call when a message is sent to a conversation and matches the pattern

Example

Copy
1
2
3
4
5
6
7
8
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages/{key}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pattern": "<string>",
  "url": "<string>"
}'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:bot:messages module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Update the chat:configuration state

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:configuration/{key}/state

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

Key of the configuration module

Min length: 1, Max length: 255
Body parameters

ConfigurationUpdateRequest is the request body for the configuration update endpoint

configured

boolean

Example

Copy
1
2
3
4
5
6
7
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:configuration/{key}/state' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "configured": true
}'

Responses

No Content

Get a list of chat:dialog modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatDialogListResponse

Content typeValue
application/json

ChatDialogListResponse

Create or update a chat:dialog module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Body parameters

ChatDialogModule is the chat:dialog module

authentication

string

Type of the authentication used in requests to the service

Pattern: (jwt|none)
key Required

string

A key to identify the dialog

options

DialogOptions

DialogOptions describes the options for chat:dialog module

title Required

DialogTitle

DialogTitle define the title of the dialog

url Required

string

The URL where the request will be made to load the content of the dialog

Example

Copy
1
2
3
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:dialog module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get a list of chat:externalPage modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatExternalPageGetAllResponse

Content typeValue
application/json

ChatExternalPageGetAllResponse

Create or update a chat:externalPage module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Body parameters

ChatExternalPageModuleRequest is the request body for creating/updating a chat:externalPage module

name

ExternalPageName

ExternalPageName represents the name of the externalPage module

url Required

string

The URL of the external page.

Example

Copy
1
2
3
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:externalPage module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get a list of chat:glance modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:glance

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:glance' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatGlanceListResponse

Content typeValue
application/json

ChatGlanceListResponse

Create or update a chat:glance module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Body parameters

ChatGlanceModule is the chat:glance module

conditions

Array<object>

icon

GlanceIcon

GlanceIcon is the icon for the glance

key

string

name

GlanceName

GlanceName is the name of the glance

queryUrl

string

target

object

weight

integer

Format: int64

Example

Copy
1
2
3
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:glance module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Update the chat:glance state

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}/state

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

Key of the glance

Min length: 1, Max length: 255
Body parameters

GlanceStateUpdateRequest is the request body for the glance update endpoint

label Required

string

Label is the text that will appear on glance hover on

metadata

object

Metadata for the glance

Example

Copy
1
2
3
4
5
6
7
8
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}/state' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "<string>",
  "metadata": {}
}'

Responses

No Content

Get a list of chat:sidebar modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatSidebarGetAllResponse

Content typeValue
application/json

ChatSidebarGetAllResponse

Create or update a chat:sidebar module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Body parameters

ChatSidebarModuleRequest is the request body for creating/updating a chat:sidebar module

authentication

object

conditions

Array<object>

icon

SidebarIcon

SidebarIcon is the icon for the sidebar

name

SidebarName

SidebarName is the name of the sidebar

url

string

weight

integer

Format: int64

Example

Copy
1
2
3
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:sidebar module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get a list of chat:webhook modules

GET /site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
start

integer

Offset for the query.

Format: int64
limit

integer

A maximum number of modules to return per call. Valid length range: 1 - 75. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ChatWebhookListResponse

Content typeValue
application/json

ChatWebhookListResponse

Create or update a chat:webhook module

PUT /site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Body parameters

ChatWebhookRequest is the payload to create a new chat:webhook webhook

event

string

The event that is to trigger a webhook invocation

Pattern: (conversation:updates|roster:updates)
url

string

URL that Stride will POST to (including a JWT token)

Example

Copy
1
2
3
4
5
6
7
8
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook/{key}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "<string>",
  "url": "<string>"
}'

Responses

No Content

A schema has not been defined for this response code.

Delete a chat:webhook module

DELETE /site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook/{key}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

key Required

string

The key to identify the resource

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Archive conversation

PUT /site/{cloudId}/conversation/{conversationId}/archive

Authentication required, with scope manage:conversation

OAuth scopes required
manage:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Example

Copy
1
2
3
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/archive' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Upload a file

POST /site/{cloudId}/conversation/{conversationId}/media

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

Cloud ID

conversationId Required

string

Conversation ID

Query parameters
name

string

File name

Body parameters
Content typeValue
application/octet-stream

object

Example

Copy
1
2
3
4
curl --request POST \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/media' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

MediaUploadResponse

Content typeValue
application/json

MediaUploadResponse

Get a file

GET /site/{cloudId}/conversation/{conversationId}/media/{mediaId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

Cloud ID

conversationId Required

string

Conversation ID

mediaId Required

string

Media ID

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/media/{mediaId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

GetAFileResponse

Content typeValue
application/json

GetAFileResponse

Delete a file

DELETE /site/{cloudId}/conversation/{conversationId}/media/{mediaId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

Cloud ID

conversationId Required

string

Conversation ID

mediaId Required

string

Media ID

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/media/{mediaId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get conversation history

GET /site/{cloudId}/conversation/{conversationId}/message

Authentication required, with scope participate:conversation

This method returns messages after/before a given messageIDs or/and timestamps. If these parameters are omitted the method returns conversation’s latest messages. Max number of messages returned is 75.

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
beforeMessage

string

Returns at most 75 messages before a provided messageID

beforeTimestamp

string

Returns at most 75 messages before a provided RFC3339 timestamp (2006-01-02T15:04:05+07:00)

afterMessage

string

Returns at most 75 latest messages after a provided messageID

afterTimestamp

string

Returns at most 75 latest messages after a provided RFC3339 timestamp (2006-01-02T15:04:05+07:00)

limit

integer

The maximum number of results. Default value is 75

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

MessageListResponse is a response that contains a list of messages.

Content typeValue
application/json

object

Send a message to a conversation

POST /site/{cloudId}/conversation/{conversationId}/message

Send a message to a conversation.

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Body parameters
Content typeValue
application/json

string

text/plain

string

text/markdown

string

Example

Copy
1
2
3
4
5
6
curl --request POST \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'

Responses

MessageSendResponse is a message send response.

Content typeValue
application/json

MessageID is an object that contains a response with a message id.

Get latest messages for conversation

GET /site/{cloudId}/conversation/{conversationId}/message/recent

Authentication required, with scope participate:conversation

Max number of messages returned is 75.

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
limit

integer

The maximum number of results. Default value is 75.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message/recent' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

MessageListResponse is a response that contains a list of messages.

Content typeValue
application/json

object

Get Message by id

GET /site/{cloudId}/conversation/{conversationId}/message/{messageId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
messageId Required

string

The ID of the Message to retrieve.

cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message/{messageId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

MessageResponse is a successful response with a single message.

Content typeValue
application/json

object

Edit a message in a conversation

PUT /site/{cloudId}/conversation/{conversationId}/message/{messageId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

messageId Required

string

The ID of the message.

Body parameters
Content typeValue
application/json

string

text/plain

string

Example

Copy
1
2
3
4
5
6
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message/{messageId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'

Responses

MessageEditResponse is a message edit response.

Content typeValue
application/json

MessageID is an object that contains a response with a message id.

Delete a message in a conversation

DELETE /site/{cloudId}/conversation/{conversationId}/message/{messageId}

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

messageId Required

string

The ID of the message.

Example

Copy
1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message/{messageId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content

Get conversation history contextually

GET /site/{cloudId}/conversation/{conversationId}/message/{messageId}/context

Authentication required, with scope participate:conversation

This method returns messages after and/or before a given messageID including the message itself. Default value for 'after' and 'before' query parameters is 0. Max number of messages returned is 75.

OAuth scopes required
participate:conversation

Request

Path parameters
messageId Required

string

The ID of the Message to retrieve.

cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Query parameters
before

integer

A number of messages to return before the Message.

Format: int64
after

integer

A number of messages to return after the Message.

Format: int64

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message/{messageId}/context' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

MessageListResponse is a response that contains a list of messages.

Content typeValue
application/json

object

Get conversation roster

GET /site/{cloudId}/conversation/{conversationId}/roster

Authentication required, with scope participate:conversation

OAuth scopes required
participate:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Example

Copy
1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/roster' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

ConversationRosterResponse

Content typeValue
application/json

ConversationRosterResponse

Update a conversation roster

PATCH /site/{cloudId}/conversation/{conversationId}/roster

Authentication required, with scope manage:conversation

OAuth scopes required
manage:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Body parameters

PatchRosterRequest body for patch conversation request

add

Array<string>

Users list of users to add to the conversation

Example

Copy
1
2
3
4
5
6
7
8
9
10
curl --request PATCH \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/roster' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "add": [
    "<string>"
  ]
}'

Responses

PatchRosterResponse

Content typeValue
application/json

PatchRosterResponse

Unarchive conversation

PUT /site/{cloudId}/conversation/{conversationId}/unarchive

Authentication required, with scope manage:conversation

OAuth scopes required
manage:conversation

Request

Path parameters
cloudId Required

string

The id of the site (cloudId)

conversationId Required

string

The conversation id

Example

Copy
1
2
3
curl --request PUT \
  --url 'https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/unarchive' \
  --header 'Authorization: Bearer <access_token>'

Responses

No Content