ChatKitty Platform REST API (v1.10.13)
Download OpenAPI specification:Download
Platform REST API OpenAPI specification (OAS). See the Interactive Docs to try ChatKitty API methods without writing code, and get the complete schema of resources exposed by the API.
Get application
Returns the ChatKitty application with this Application ID
Authorizations:
read:application
Responses
Request samples
- cURL
- JavaScript
curl --location --request GET 'https://api.chatkitty.com/v1/applications/1/' \ --header 'accept: application/hal+json' \ --header 'Authorization: Bearer 549f95bc-bb8c-4a55-8caf-ba39391004f3'
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "name": "Rockstar App",
- "key": "19b458d0-2b50-491c-8f13-65ec12f3978e",
- "properties": { },
- "createdTime": "2020-10-02T20:29:25.316Z",
- "_links": {
- "users": {
- "templated": true
}, - "channels": {
- "templated": true
}, - "pushNotificationCredentials": {
}
}
}
Get application settings
Returns the current settings configuring this application
Authorizations:
read:application
Responses
Response samples
- 200
- 401
- 403
- 404
{- "guestUsers": "DISABLED"
}
Update application settings
Update the settings configuring this application
Authorizations:
update:application
Request Body schema: application/json
guestUsers required | string Enum: "DISABLED" "ENABLED" Toggles guest users enabled |
Responses
Request samples
- Payload
{- "guestUsers": "DISABLED"
}
Response samples
- 200
- 401
- 403
- 404
{- "guestUsers": "DISABLED"
}
Get channels
Returns a page of channels belonging to this application
Authorizations:
read:channel
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
type | string Enum: "DIRECT" "PUBLIC" "PRIVATE" Filters by channel type |
members | Array of strings unique Filters by channel members using their usernames |
startTime | string <date-time> Filters for channels created within a time range: start time |
endTime | string <date-time> Filters for channels created within a time range: end time |
properties | string Filters by channel custom properties |
direct | boolean Filters for direct channels |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "channels": [
- {
- "id": 15252,
- "type": "DIRECT",
- "creator": {
- "id": 19652,
- "type": "PERSON",
- "name": "rexyfexy@gmail.com",
- "displayName": "doark",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "members": [
- {
- "id": 19652,
- "type": "PERSON",
- "name": "rexyfexy@gmail.com",
- "displayName": "doark",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - {
- "id": 19452,
- "type": "PERSON",
- "name": "aa",
- "displayName": "emra",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}
], - "properties": { },
- "createdTime": "2021-05-05T00:38:24.888Z",
- "_links": {
- "participants": {
},
}
}, - {
- "id": 55913,
- "type": "PUBLIC",
- "name": "b0a0bd55-921a-4f72-8ee3-f26c6fda0bb7",
- "displayName": "Our public channel",
- "properties": { },
- "createdTime": "2021-09-28T01:35:40.967Z",
- "_links": {
- "participants": {
},
}
}, - {
- "id": 2402,
- "type": "PUBLIC",
- "name": "#test",
- "displayName": "Test Channel",
- "creator": {
- "id": 4153,
- "type": "PERSON",
- "name": "test@mail.com",
- "displayName": "mridx",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "properties": { },
- "createdTime": "2020-12-13T21:12:09.195Z",
- "_links": {
}
}, - {
- "id": 856,
- "type": "PUBLIC",
- "name": "mkm",
- "displayName": "Meme Channel",
- "creator": {
- "id": 1504,
- "type": "PERSON",
- "name": "njnj@vghf.jk",
- "displayName": "mkm",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "lastReceivedMessage": {
- "id": 17654,
- "type": "TEXT",
- "channelId": 856,
- "user": {
- "id": 15402,
- "type": "PERSON",
- "name": "paras@code.co",
- "displayName": "Paras",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "body": "ghk",
- "properties": { },
- "createdTime": "2021-03-31T06:00:28.680Z"
}, - "properties": { },
- "createdTime": "2020-11-25T07:46:45.775Z",
- "_links": {
}
}, - {
- "id": 1302,
- "type": "PUBLIC",
- "name": "SONU KUMAR",
- "displayName": "SONU KUMAR",
- "creator": {
- "id": 2302,
- "type": "PERSON",
- "name": "852122",
- "displayName": "SONU KUMAR",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "lastReceivedMessage": {
- "id": 44530,
- "type": "TEXT",
- "channelId": 1302,
- "user": {
- "id": 39826,
- "type": "PERSON",
- "name": "steve@innersync.com",
- "displayName": "Steve Williams",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "body": "Checking out",
- "properties": { },
- "createdTime": "2021-09-14T18:02:56.066Z"
}, - "properties": { },
- "createdTime": "2020-12-02T05:10:01.260Z",
- "_links": {
}
}
]
}, - "_links": {
}, - "page": {
- "size": 5,
- "totalElements": 2020,
- "totalPages": 404,
- "number": 0
}
}
Create a channel
Creates a new channel or returns an equivalent existing channel
Authorizations:
create:channel
Request Body schema: application/json
object Custom data associated with this channel | |
Array of ChatUserIdReference (object) or ChatUserUsernameReference (object) unique [ items ] List of user references of members of this channel | |
object (ResourceReference) Username of the user who created this channel | |
type required | string |
name | string The unique name of this channel used to reference the channel. If absent defaults to a random UUID |
displayName | string Human readable name of this channel shown to users. If absent defaults to the channel name |
Responses
Request samples
- Payload
{- "type": "DIRECT",
- "members": [
- {
- "username": "jane@chatkitty.com"
}, - {
- "username": "john@chatkitty.com"
}
]
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 55913,
- "type": "PUBLIC",
- "name": "b0a0bd55-921a-4f72-8ee3-f26c6fda0bb7",
- "displayName": "Our public channel",
- "properties": { },
- "createdTime": "2021-09-28T01:35:40.967Z",
- "_links": {
- "participants": {
},
}
}
Get a channel
Returns a channel by ID
Authorizations:
read:channel
path Parameters
id required | integer <int64> Channel ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 55913,
- "type": "PUBLIC",
- "name": "b0a0bd55-921a-4f72-8ee3-f26c6fda0bb7",
- "displayName": "Our public channel",
- "properties": { },
- "createdTime": "2021-09-28T01:35:40.967Z",
- "_links": {
- "participants": {
},
}
}
Update a channel
Updates a channel properties
Authorizations:
read:channel
update:channel
path Parameters
id required | integer <int64> Channel ID |
Request Body schema: application/json
id required | integer <int64> 64-bit integer identifier associated with this resource |
type required | string Enum: "DIRECT" "PUBLIC" "PRIVATE" The type of this channel |
name | string The unique name of this channel used to reference the channel |
displayName | string Human readable name of this channel shown to users |
object (ChatUserProperties) | |
Array of objects (ChatUserProperties) [ items ] The members of this channel. Present if this is a direct channel. For other channel types, use get channel members | |
object (MessageProperties) The message last received associated with this channel | |
required | object Custom data associated with this channel |
createdTime required | string <date-time> The ISO date-time this channel was created |
object (Links) |
Responses
Request samples
- Payload
{- "id": 0,
- "type": "DIRECT",
- "name": "string",
- "displayName": "string",
- "creator": {
- "id": 0,
- "type": "PERSON",
- "name": "string",
- "displayName": "string",
- "displayPictureUrl": "string",
- "isGuest": true,
- "presence": {
- "status": "string",
- "online": true
}, - "callStatus": "AVAILABLE",
- "properties": {
- "property1": { },
- "property2": { }
}
}, - "members": [
- {
- "id": 0,
- "type": "PERSON",
- "name": "string",
- "displayName": "string",
- "displayPictureUrl": "string",
- "isGuest": true,
- "presence": {
- "status": "string",
- "online": true
}, - "callStatus": "AVAILABLE",
- "properties": {
- "property1": { },
- "property2": { }
}
}
], - "lastReceivedMessage": {
- "id": 0,
- "type": "SYSTEM_TEXT",
- "nestedLevel": 0,
- "channelId": 0,
- "user": {
- "id": 0,
- "type": "PERSON",
- "name": "string",
- "displayName": "string",
- "displayPictureUrl": "string",
- "isGuest": true,
- "presence": {
- "status": "string",
- "online": true
}, - "callStatus": "AVAILABLE",
- "properties": {
- "property1": { },
- "property2": { }
}
}, - "body": "string",
- "file": {
- "type": "HOSTED",
- "url": "string",
- "name": "string",
- "contentType": "string",
- "size": 0
}, - "groupTag": "string",
- "links": [
- {
- "source": "string",
- "startPosition": 0,
- "endPosition": 0,
- "preview": {
- "url": "string",
- "title": "string",
- "image": {
- "source": "string"
}, - "description": "string",
- "siteName": "string"
}
}
], - "mentions": [
- {
- "type": "CHANNEL",
- "tag": "string",
- "startPosition": 0,
- "endPosition": 0,
- "user": {
- "id": 0,
- "type": "PERSON",
- "name": "string",
- "displayName": "string",
- "displayPictureUrl": "string",
- "isGuest": true,
- "presence": {
- "status": "string",
- "online": true
}, - "callStatus": "AVAILABLE",
- "properties": {
- "property1": { },
- "property2": { }
}
}
}
], - "reactions": [
- {
- "emoji": {
- "character": "string",
- "description": "string",
- "aliases": [
- "string"
], - "tags": [
- "string"
]
}, - "users": [
- {
- "id": 0,
- "type": "PERSON",
- "name": "string",
- "displayName": "string",
- "displayPictureUrl": "string",
- "isGuest": true,
- "presence": {
- "status": "string",
- "online": true
}, - "callStatus": "AVAILABLE",
- "properties": {
- "property1": { },
- "property2": { }
}
}
], - "count": 0
}
], - "repliesCount": 0,
- "properties": {
- "property1": { },
- "property2": { }
}, - "lastEditedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z"
}, - "properties": {
- "property1": { },
- "property2": { }
}, - "createdTime": "2019-08-24T14:15:22Z",
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 55913,
- "type": "PUBLIC",
- "name": "b0a0bd55-921a-4f72-8ee3-f26c6fda0bb7",
- "displayName": "Our public channel",
- "properties": { },
- "createdTime": "2021-09-28T01:35:40.967Z",
- "_links": {
- "participants": {
},
}
}
Delete a channel
Deletes a channel by ID
Authorizations:
read:channel
delete:channel
path Parameters
id required | integer <int64> Channel ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "name": "Rockstar App",
- "key": "19b458d0-2b50-491c-8f13-65ec12f3978e",
- "properties": { },
- "createdTime": "2020-10-02T20:29:25.316Z",
- "_links": {
- "users": {
- "templated": true
}, - "channels": {
- "templated": true
}, - "pushNotificationCredentials": {
}
}
}
Send a channel event
Sends a custom channel event
Authorizations:
read:channel
create:channel_event
path Parameters
id required | integer <int64> Channel ID |
Request Body schema: application/json
type required | string |
required | object |
Responses
Request samples
- Payload
{- "type": "string",
- "properties": {
- "property1": { },
- "property2": { }
}
}
Response samples
- 200
- 401
- 403
- 404
{- "type": "string",
- "user": {
- "id": 0,
- "type": "PERSON",
- "name": "string",
- "displayName": "string",
- "displayPictureUrl": "string",
- "isGuest": true,
- "presence": {
- "status": "string",
- "online": true
}, - "callStatus": "AVAILABLE",
- "properties": {
- "property1": { },
- "property2": { }
}
}, - "properties": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Get channel invites
Get a page of invites sent to join this channel
Authorizations:
read:channel_invite
path Parameters
id required | integer <int64> Channel ID |
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "invites": [
- {
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
]
}, - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "page": {
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "number": 0
}
}
Send a channel invite
Sends a channel invite to user
Authorizations:
read:channel
read:user
create:channel_invite
path Parameters
id required | integer <int64> Channel ID |
Request Body schema: application/json
required | ChatUserIdReference (object) or ChatUserUsernameReference (object) | ||
One of
|
Responses
Request samples
- Payload
{- "user": {
- "username": "jane@chatkitty.com",
- "id": 0
}
}
Response samples
- 200
- 401
- 403
- 404
{- "createdTime": "2019-08-24T14:15:22Z",
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Get a channel's members
Returns a page of channel members
Authorizations:
read:channel
read:channel_membership
path Parameters
id required | integer <int64> Channel ID |
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "users": [
- {
- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
]
}, - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "page": {
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "number": 0
}
}
Add a channel member
Makes a user a group channel member
Authorizations:
read:channel
read:user
create:channel_membership
path Parameters
id required | integer <int64> Channel ID |
Request Body schema: application/json
id required | integer <int64> User ID associated with this user |
Responses
Request samples
- Payload
{- "username": "jane@chatkitty.com"
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 55913,
- "type": "PUBLIC",
- "name": "b0a0bd55-921a-4f72-8ee3-f26c6fda0bb7",
- "displayName": "Our public channel",
- "properties": { },
- "createdTime": "2021-09-28T01:35:40.967Z",
- "_links": {
- "participants": {
},
}
}
Remove a channel member
Removes a user from a group channel
Authorizations:
read:channel
read:user
delete:channel_membership
path Parameters
id required | integer <int64> Channel ID |
user_id required | integer <int64> User ID of member to be removed |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 55913,
- "type": "PUBLIC",
- "name": "b0a0bd55-921a-4f72-8ee3-f26c6fda0bb7",
- "displayName": "Our public channel",
- "properties": { },
- "createdTime": "2021-09-28T01:35:40.967Z",
- "_links": {
- "participants": {
},
}
}
Get channel memberships
Returns a page of channel membership info for this channel
Authorizations:
read:channel
read:channel_membership
path Parameters
id required | integer <int64> Channel ID |
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "memberships": [
- {
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
]
}, - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "page": {
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "number": 0
}
}
Get channel messages
Get a page of messages sent in this channel
Authorizations:
read:channel
read:message
path Parameters
id required | integer <int64> Channel ID |
query Parameters
start | integer <int64> |
next | integer <int64> |
size | integer <int32> |
relation | string Enum: "SELF" "PREVIOUS" "NEXT" |
username | string |
query | string |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "messages": [
- {
- "id": 44902,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39953,
- "type": "PERSON",
- "name": "hey@mailinator.com",
- "displayName": "hey",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "🌞",
- "properties": { },
- "createdTime": "2021-09-16T20:45:33.696Z",
- "_links": {
}
}, - {
- "id": 44701,
- "type": "TEXT",
- "channelId": 802,
- "user": {
- "id": 39906,
- "type": "PERSON",
- "name": "sean.donald@gmail.com",
- "displayName": "zolo",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "test",
- "properties": { },
- "createdTime": "2021-09-16T14:57:55.903Z",
- "_links": {
}
}, - {
- "id": 44700,
- "type": "TEXT",
- "channelId": 802,
- "user": {
- "id": 39906,
- "type": "PERSON",
- "name": "sean.donald@gmail.com",
- "displayName": "zolo",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "hi",
- "properties": { },
- "createdTime": "2021-09-16T14:57:46.056Z",
- "_links": {
}
}, - {
- "id": 44760,
- "type": "TEXT",
- "channelId": 1255,
- "user": {
- "id": 39841,
- "type": "PERSON",
- "name": "ho@mailinator.com",
- "displayName": "ho",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "do?",
- "properties": { },
- "createdTime": "2021-09-16T09:14:09.585Z",
- "_links": {
}
}, - {
- "id": 44759,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39841,
- "type": "PERSON",
- "name": "ho@mailinator.com",
- "displayName": "ho",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "ok",
- "properties": { },
- "createdTime": "2021-09-16T09:13:48.030Z",
- "_links": {
}
}
]
}, - "page": {
- "size": 5
}
}
Send a channel message
Sends a message in this channel as the system or on behalf of a user
Authorizations:
read:channel
read:user
create:message
path Parameters
id required | integer <int64> Channel ID |
Request Body schema:
Responses
Request samples
- Payload
{- "properties": {
- "property1": { },
- "property2": { }
}, - "user": {
- "id": 0
}, - "groupTag": "string",
- "type": "string",
- "file": {
- "name": "jane.png",
- "contentType": "image/png",
- "size": 32768
}
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 44902,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39953,
- "type": "PERSON",
- "name": "hey@mailinator.com",
- "displayName": "hey",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "🌞",
- "properties": { },
- "createdTime": "2021-09-16T20:45:33.696Z",
- "_links": {
}
}
Add a channel moderator
Makes a user a group channel moderator
Authorizations:
read:channel
read:user
read:channel_membership
create:channel_moderator
path Parameters
id required | integer <int64> Channel ID |
Request Body schema: application/json
id required | integer <int64> User ID associated with this user |
Responses
Request samples
- Payload
{- "username": "jane@chatkitty.com"
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
Get channel participants
Get a page of channel active participants: members that currently online
Authorizations:
read:channel
read:chat_session
path Parameters
id required | integer <int64> Channel ID |
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "users": [
- {
- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
]
}, - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "page": {
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "number": 0
}
}
Get jobs
Returns a page of jobs created for this application
Authorizations:
read:job
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
running | boolean Filters for jobs currently running |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "jobs": [
- {
- "id": 1,
- "type": "CHANNEL_IMPORT",
- "state": "FAILED",
- "createdTime": "2021-09-28T04:19:41.255Z",
- "endedTime": "2021-09-28T04:19:42.230Z",
- "_links": {
}
}, - {
- "id": 52,
- "type": "CHANNEL_IMPORT",
- "state": "FAILED",
- "createdTime": "2021-09-28T05:30:08.902Z",
- "endedTime": "2021-09-28T05:30:09.571Z",
- "_links": {
}
}, - {
- "id": 53,
- "type": "CHANNEL_IMPORT",
- "state": "FINISHED",
- "createdTime": "2021-09-28T05:30:44.265Z",
- "endedTime": "2021-09-28T05:30:44.692Z",
- "_links": {
}
}, - {
- "id": 54,
- "type": "CHANNEL_IMPORT",
- "state": "FINISHED",
- "createdTime": "2021-09-28T05:35:35.075Z",
- "endedTime": "2021-09-28T05:36:15.755Z",
- "_links": {
}
}, - {
- "id": 102,
- "type": "CHANNEL_MEMBERS_IMPORT",
- "state": "FINISHED",
- "createdTime": "2021-09-29T04:52:22.895Z",
- "endedTime": "2021-09-29T04:52:58.941Z",
- "_links": {
}
}
]
}, - "_links": {
}, - "page": {
- "size": 25,
- "totalElements": 5,
- "totalPages": 1,
- "number": 0
}
}
Get a job
Returns a job by ID
Authorizations:
read:job
path Parameters
id required | integer <int64> Job ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 53,
- "type": "CHANNEL_IMPORT",
- "state": "PENDING",
- "createdTime": "2021-09-28T05:30:44.265Z",
- "endedTime": "2021-09-28T05:30:44.692Z",
- "_links": {
}
}
Get messages
Returns a page of messages belonging to this application
Authorizations:
read:message
query Parameters
start | integer <int64> |
next | integer <int64> |
size | integer <int32> |
relation | string Enum: "SELF" "PREVIOUS" "NEXT" |
username | string Filters messages by a sender's username |
query | string Filters text messages by text contained in the message body |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "messages": [
- {
- "id": 44902,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39953,
- "type": "PERSON",
- "name": "hey@mailinator.com",
- "displayName": "hey",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "🌞",
- "properties": { },
- "createdTime": "2021-09-16T20:45:33.696Z",
- "_links": {
}
}, - {
- "id": 44701,
- "type": "TEXT",
- "channelId": 802,
- "user": {
- "id": 39906,
- "type": "PERSON",
- "name": "sean.donald@gmail.com",
- "displayName": "zolo",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "test",
- "properties": { },
- "createdTime": "2021-09-16T14:57:55.903Z",
- "_links": {
}
}, - {
- "id": 44700,
- "type": "TEXT",
- "channelId": 802,
- "user": {
- "id": 39906,
- "type": "PERSON",
- "name": "sean.donald@gmail.com",
- "displayName": "zolo",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "hi",
- "properties": { },
- "createdTime": "2021-09-16T14:57:46.056Z",
- "_links": {
}
}, - {
- "id": 44760,
- "type": "TEXT",
- "channelId": 1255,
- "user": {
- "id": 39841,
- "type": "PERSON",
- "name": "ho@mailinator.com",
- "displayName": "ho",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "do?",
- "properties": { },
- "createdTime": "2021-09-16T09:14:09.585Z",
- "_links": {
}
}, - {
- "id": 44759,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39841,
- "type": "PERSON",
- "name": "ho@mailinator.com",
- "displayName": "ho",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "ok",
- "properties": { },
- "createdTime": "2021-09-16T09:13:48.030Z",
- "_links": {
}
}
]
}, - "page": {
- "size": 5
}
}
Delete messages
Deletes all messages belonging to this application
Authorizations:
read:message
delete:message
Responses
Response samples
- 401
- 403
- 404
{- "error": "unauthorized",
- "error_description": "Full authentication is required to access this resource"
}
Get a message
Returns a message by ID
Authorizations:
read:message
path Parameters
id required | integer <int64> Message ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 44902,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39953,
- "type": "PERSON",
- "name": "hey@mailinator.com",
- "displayName": "hey",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "🌞",
- "properties": { },
- "createdTime": "2021-09-16T20:45:33.696Z",
- "_links": {
}
}
Delete a message
Deletes a message by ID
Authorizations:
read:message
delete:message
path Parameters
id required | integer <int64> Message ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 0,
- "type": "MAIN",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "createdTime": "2019-08-24T14:15:22Z",
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Get users
Returns a page of users belonging to this application
Authorizations:
read:user
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
name | string Filters by username |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "users": [
- {
- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
]
}, - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "page": {
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "number": 0
}
}
Create a user
Creates a new user
Authorizations:
create:user
Request Body schema: application/json
name required | string The unique name used to identify this user across ChatKitty. Also known as username |
displayName required | string Human readable name of this user. Shown to other users |
isGuest required | boolean True if this user was created by a guest user session |
object Custom data associated with this user |
Responses
Request samples
- Payload
{- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "isGuest": false,
- "properties": {
- "favoriteNumber": 42
}
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
Check a user exists
Checks if a user exists
Authorizations:
read:user
query Parameters
name required | string Username of the user |
Responses
Response samples
- 200
- 401
- 403
- 404
{ }
Get a user
Returns a user by ID
Authorizations:
read:user
path Parameters
id required | integer <int64> User ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
Update a user
Updates a user
Authorizations:
read:user
update:user
path Parameters
id required | integer <int64> User ID |
Request Body schema: application/json
id required | integer <int64> 64-bit integer identifier associated with this resource |
type required | string Enum: "PERSON" "BOT" Type of user |
name required | string The unique name used to identify this user across ChatKitty. Also known as username |
displayName required | string Human readable name of this user. Shown to other users |
displayPictureUrl required | string URL for this user's display picture |
isGuest required | boolean True if this user was created by a guest user session |
required | object (ChatUserPresenceProperties) Presence status of this user |
callStatus | string Enum: "AVAILABLE" "IN_CALL" Call presence status of this user |
required | object Custom data associated with this user |
Responses
Request samples
- Payload
{- "id": 0,
- "type": "PERSON",
- "name": "string",
- "displayName": "string",
- "displayPictureUrl": "string",
- "isGuest": true,
- "presence": {
- "status": "string",
- "online": true
}, - "callStatus": "AVAILABLE",
- "properties": {
- "property1": { },
- "property2": { }
}
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
Delete a user
Delets a user
Authorizations:
read:user
delete:user
path Parameters
id required | integer <int64> User ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "name": "Rockstar App",
- "key": "19b458d0-2b50-491c-8f13-65ec12f3978e",
- "properties": { },
- "createdTime": "2020-10-02T20:29:25.316Z",
- "_links": {
- "users": {
- "templated": true
}, - "channels": {
- "templated": true
}, - "pushNotificationCredentials": {
}
}
}
Partially update a user
Updates a user by setting the values of the parameters passed. Any parameters not provided will be left unchanged
Authorizations:
read:user
update:user
path Parameters
id required | integer <int64> User ID |
Request Body schema: application/json+merge-patch
id | integer <int64> |
type | string Enum: "PERSON" "BOT" Type of user |
name | string The unique name used to identify this user across ChatKitty. Also known as username |
displayName | string Human readable name of this user. Shown to other users |
displayPictureUrl | string URL for this user's display picture |
isGuest | boolean True if this user was created by a guest user session |
object (ChatUserPresenceProperties) Presence status of this user | |
callStatus | string Enum: "AVAILABLE" "IN_CALL" Call presence status of this user |
object Custom data associated with this user | |
object (Links) |
Responses
Request samples
- Payload
{- "displayName": "Jane Doe"
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
Get a user's channels
Returns a page of channels for this user created or joined
Authorizations:
read:user
read:channels
path Parameters
id required | integer <int64> User ID |
query Parameters
page | integer >= 0 Default: 0 Zero-based page index (0..N) |
size | integer >= 1 Default: 25 The size of the page to be returned |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "channels": [
- {
- "id": 15252,
- "type": "DIRECT",
- "creator": {
- "id": 19652,
- "type": "PERSON",
- "name": "rexyfexy@gmail.com",
- "displayName": "doark",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "members": [
- {
- "id": 19652,
- "type": "PERSON",
- "name": "rexyfexy@gmail.com",
- "displayName": "doark",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - {
- "id": 19452,
- "type": "PERSON",
- "name": "aa",
- "displayName": "emra",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}
], - "properties": { },
- "createdTime": "2021-05-05T00:38:24.888Z",
- "_links": {
- "participants": {
},
}
}, - {
- "id": 55913,
- "type": "PUBLIC",
- "name": "b0a0bd55-921a-4f72-8ee3-f26c6fda0bb7",
- "displayName": "Our public channel",
- "properties": { },
- "createdTime": "2021-09-28T01:35:40.967Z",
- "_links": {
- "participants": {
},
}
}, - {
- "id": 2402,
- "type": "PUBLIC",
- "name": "#test",
- "displayName": "Test Channel",
- "creator": {
- "id": 4153,
- "type": "PERSON",
- "name": "test@mail.com",
- "displayName": "mridx",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "properties": { },
- "createdTime": "2020-12-13T21:12:09.195Z",
- "_links": {
}
}, - {
- "id": 856,
- "type": "PUBLIC",
- "name": "mkm",
- "displayName": "Meme Channel",
- "creator": {
- "id": 1504,
- "type": "PERSON",
- "name": "njnj@vghf.jk",
- "displayName": "mkm",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "lastReceivedMessage": {
- "id": 17654,
- "type": "TEXT",
- "channelId": 856,
- "user": {
- "id": 15402,
- "type": "PERSON",
- "name": "paras@code.co",
- "displayName": "Paras",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "body": "ghk",
- "properties": { },
- "createdTime": "2021-03-31T06:00:28.680Z"
}, - "properties": { },
- "createdTime": "2020-11-25T07:46:45.775Z",
- "_links": {
}
}, - {
- "id": 1302,
- "type": "PUBLIC",
- "name": "SONU KUMAR",
- "displayName": "SONU KUMAR",
- "creator": {
- "id": 2302,
- "type": "PERSON",
- "name": "852122",
- "displayName": "SONU KUMAR",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "lastReceivedMessage": {
- "id": 44530,
- "type": "TEXT",
- "channelId": 1302,
- "user": {
- "id": 39826,
- "type": "PERSON",
- "name": "steve@innersync.com",
- "displayName": "Steve Williams",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "callStatus": "AVAILABLE",
- "properties": { }
}, - "body": "Checking out",
- "properties": { },
- "createdTime": "2021-09-14T18:02:56.066Z"
}, - "properties": { },
- "createdTime": "2020-12-02T05:10:01.260Z",
- "_links": {
}
}
]
}, - "_links": {
}, - "page": {
- "size": 5,
- "totalElements": 2020,
- "totalPages": 404,
- "number": 0
}
}
Update a user's display picture
Updates a user's display picture with a reference to an external file
Authorizations:
read:user
update:user
path Parameters
id required | integer <int64> User ID |
Request Body schema:
url required | string External file URL |
name required | string File name |
contentType required | string File MIME content type |
size required | integer <int64> File size in bytes |
Responses
Request samples
- Payload
{- "name": "jane.png",
- "contentType": "image/png",
- "size": 32768
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
Get a user's messages
Returns a page of messages sent by this user
Authorizations:
read:user
read:channels
path Parameters
id required | integer <int64> User ID |
query Parameters
start | integer <int64> |
next | integer <int64> |
size | integer <int32> |
relation | string Enum: "SELF" "PREVIOUS" "NEXT" |
unread | boolean Filters by returning unread messages |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "messages": [
- {
- "id": 44902,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39953,
- "type": "PERSON",
- "name": "hey@mailinator.com",
- "displayName": "hey",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "🌞",
- "properties": { },
- "createdTime": "2021-09-16T20:45:33.696Z",
- "_links": {
}
}, - {
- "id": 44701,
- "type": "TEXT",
- "channelId": 802,
- "user": {
- "id": 39906,
- "type": "PERSON",
- "name": "sean.donald@gmail.com",
- "displayName": "zolo",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "test",
- "properties": { },
- "createdTime": "2021-09-16T14:57:55.903Z",
- "_links": {
}
}, - {
- "id": 44700,
- "type": "TEXT",
- "channelId": 802,
- "user": {
- "id": 39906,
- "type": "PERSON",
- "name": "sean.donald@gmail.com",
- "displayName": "zolo",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "hi",
- "properties": { },
- "createdTime": "2021-09-16T14:57:46.056Z",
- "_links": {
}
}, - {
- "id": 44760,
- "type": "TEXT",
- "channelId": 1255,
- "user": {
- "id": 39841,
- "type": "PERSON",
- "name": "ho@mailinator.com",
- "displayName": "ho",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "do?",
- "properties": { },
- "createdTime": "2021-09-16T09:14:09.585Z",
- "_links": {
}
}, - {
- "id": 44759,
- "type": "TEXT",
- "channelId": 702,
- "user": {
- "id": 39841,
- "type": "PERSON",
- "name": "ho@mailinator.com",
- "displayName": "ho",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { }
}, - "body": "ok",
- "properties": { },
- "createdTime": "2021-09-16T09:13:48.030Z",
- "_links": {
}
}
]
}, - "page": {
- "size": 5
}
}
Get a user's notifications
Returns a page of notifications received by this user
Authorizations:
read:user
read:notifications
path Parameters
id required | integer <int64> User ID |
query Parameters
start | integer <int64> |
next | integer <int64> |
size | integer <int32> |
relation | string Enum: "SELF" "PREVIOUS" "NEXT" |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "_embedded": {
- "notifications": [
- {
- "id": 0,
- "title": "string",
- "body": "string",
- "channel": {
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}, - "data": {
- "type": "string",
- "recipient": {
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}, - "_relays": {
- "property1": { },
- "property2": { }
}
}, - "muted": true,
- "createdTime": "2019-08-24T14:15:22Z",
- "readTime": "2019-08-24T14:15:22Z",
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
]
}, - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "page": {
- "size": 0
}
}
Get a user secret
Returns a user secret
Authorizations:
read:user_secret
path Parameters
id required | integer <int64> User ID |
name required | string The secret's name |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "secret": { },
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Set a user secret
Sets a user secret's value
Authorizations:
read:user
update:user_secret
path Parameters
id required | integer <int64> User ID |
name required | string The secret's name |
Request Body schema: application/json
secret | object Secret value |
object (Links) |
Responses
Request samples
- Payload
{- "secret": { },
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}
Remove a user secret
Removes a user secret's value
Authorizations:
read:user
delete:user_secret
path Parameters
id required | integer <int64> User ID |
name required | string The secret's name |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": 1,
- "type": "PERSON",
- "name": "jane@chatkitty.com",
- "displayName": "Jane Doe",
- "presence": {
- "status": "UNAVAILABLE",
- "online": false
}, - "properties": { },
- "_links": {
}
}