The Organization API allows you to list, view, create and manage Sendbird applications, their features, and members in an organization. A Sendbird application performs core functionalities and features for Sendbird Chat, Sendbird Calls, and Sendbird Desk.
Each HTTP request should be authenticated with the organization API key in the request header. The unique API key can be found on the Sendbird Dashboard
The following tables show the list of properties in an organization resource for application, feature, and member.
Property name | Type | Description |
---|---|---|
app_id | string | The unique ID of the application. |
app_name | string | The name of the application. |
region | nested object | The region information of the application. |
premium_features | nested object | Information about premium features used in the application. |
push_notification | nested object | The push notification settings used in the application. |
auto_event_message | nested object | The auto event message settings used in the application. |
created_at | datetime | The date and time when the application was created. |
Property name | Type | Description |
---|---|---|
auto_thumbnail | boolean | Indicates whether to turn on or off the thumbnail auto-generator feature. (Default: false) |
translation_tools | boolean | Indicates whether to turn on or off the message auto-translation feature. (Default: false) |
image_moderation | boolean | Indicates whether to turn on or off the image moderation feature. (Default: false) |
data_export | boolean | Indicates whether to turn on or off the data export feature. |
domain_filter | boolean | Indicates whether to turn on or off the domain filter feature. (Default: false) |
profanity_filter | boolean | Indicates whether to turn on or off the profanity filter feature. (Default: false) |
delivery_receipt | boolean | Indicates whether to turn on or off the delivery receipt feature. |
announcement | boolean | Indicates whether to turn on or off the announcements feature. (Default: false) |
supergroup | boolean | Indicates whether to turn on or off a Supergroup channel. (Default: false) |
advanced_analytics | boolean | Indicates whether to turn on or off the advanced analytics feature. |
message_search | boolean | Indicates whether to turn on or off the message search feature. (Default: false) |
Property name | Type | Description |
---|---|---|
id | int | The unique ID of the member. |
role | string | The role given to the member. |
created_at | datetime | The date and time when the member was created. |
status | string | The account status of the member. Valid values are the following: |
user.id | int | The unique user ID of the member. |
user.email | string | The email address of the member. |
user.date_joined | datetime | The date and time when the member joined the organization. |
user.is_active | boolean | Indicates whether the member's status is ACTIVE. |
user.profile.id | int | The unique ID of the member's profile. |
user.profile.nickname | string | The member's nickname. |
user.first_name | string | The member's first name. |
user.last_name | string | The member's last name. |
organization | int | The unique ID of the organization. |
organization_member_role | object | Detailed information about the member's role. |
- API endpoints in this page are relative to the base URL allocated to your Sendbird application. In this page, the
/applications
endpoint refers tohttps://gate.sendbird.com/api/v2/applications
.
Action | HTTP request |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|