POST /2/chat/conversations/group
Creates a new encrypted Chat group conversation on behalf of the authenticated user.
Servers
- https://api.x.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
group_members[] |
Array | Yes |
User IDs of group members to include in the conversation. |
group_description |
String | No |
Description for the group conversation. |
group_admins[] |
Array | No |
User IDs of group admins. Defaults to the creator if omitted. |
base64_encoded_key_rotation |
String | No |
Base64-encoded key rotation payload. |
conversation_participant_keys[] |
Array | Yes |
Encrypted conversation keys for each participant. |
conversation_participant_keys[].encrypted_conversation_key |
String | No |
Conversation key encrypted with this participant's public key. |
conversation_participant_keys[].public_key_version |
String | No |
Version of the participant's public key used for encryption. |
conversation_participant_keys[].user_id |
String | No |
Participant user ID. |
group_avatar_url |
String | No |
URL of the avatar image for the group conversation. |
ttl_msec |
String | No |
Message time-to-live in milliseconds. Messages expire after this duration. |
action_signatures[] |
Array | No |
Cryptographic signatures for the create action. |
action_signatures[].message_id |
String | No |
ID of the message being signed. |
action_signatures[].message_event_signature |
Object | No |
Message event signature for verification. |
action_signatures[].message_event_signature.message_signing_key_info_list[] |
Array | No |
List of signing key information for message verification. |
action_signatures[].message_event_signature.message_signing_key_info_list[].member_id |
String | No |
The member ID associated with this signing key. |
action_signatures[].message_event_signature.message_signing_key_info_list[].signing_public_key |
String | No |
The signing public key. |
action_signatures[].message_event_signature.message_signing_key_info_list[].public_key_version |
String | No |
The version of the public key. |
action_signatures[].message_event_signature.signature |
String | No |
The signature of the message event. |
action_signatures[].message_event_signature.signing_public_key |
String | No |
The public key used for signing. |
action_signatures[].message_event_signature.signature_version |
String | No |
The version of the signature algorithm. |
action_signatures[].message_event_signature.public_key_version |
String | No |
The version of the public key used for signing. |
action_signatures[].encoded_message_event_detail |
String | No |
Base64-encoded message event detail. |
action_signatures[].signature_payload |
String | No |
Cryptographic signature payload. |
conversation_key_version |
String | Yes |
Version of the conversation encryption key. |
conversation_id |
String | Yes |
Client-generated conversation ID. |
group_name |
String | No |
Display name for the group conversation. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.