Group invites and join requests
Enable a Chat group invite link
Turns on the invite link for an encrypted Chat group conversation and returns the link details. The client builds the link and sends it as invite_url, in the form https://x.com/i/chat/group_join/<conversation_id>/<token>, where the token is exactly 10 letters, digits, '-' or '_'. invite_url is required when action_signatures is sent. To make the link expire, send validity_duration_msec or validity_expiry_timestamp_msec. With action_signatures, send validity_expiry_timestamp_msec, because the signed payload carries the expiry. The group name and avatar sent here are stored unencrypted and shown to anyone who opens the link.
POST
/
2
/
chat
/
conversations
/
{id}
/
invite
Enable a Chat group invite link
curl --request POST \
--url https://api.x.com/2/chat/conversations/{id}/invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"affiliate_user_id": "<string>",
"decrypted_avatar_url": "<string>",
"decrypted_title": "<string>",
"invite_url": "<string>",
"validity_duration_msec": "<string>",
"validity_expiry_timestamp_msec": "<string>",
"welcome_message": "<string>"
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}/invite"
payload = {
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"affiliate_user_id": "<string>",
"decrypted_avatar_url": "<string>",
"decrypted_title": "<string>",
"invite_url": "<string>",
"validity_duration_msec": "<string>",
"validity_expiry_timestamp_msec": "<string>",
"welcome_message": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action_signatures: [
{
encoded_message_event_detail: '<string>',
message_event_signature: {
public_key_version: '<string>',
signature: '<string>',
signature_version: '<string>',
message_signing_key_info_list: [
{
member_id: '<string>',
public_key_version: '<string>',
signing_public_key: '<string>'
}
],
signing_public_key: '<string>'
},
message_id: '<string>',
signature_payload: '<string>'
}
],
affiliate_user_id: '<string>',
decrypted_avatar_url: '<string>',
decrypted_title: '<string>',
invite_url: '<string>',
validity_duration_msec: '<string>',
validity_expiry_timestamp_msec: '<string>',
welcome_message: '<string>'
})
};
fetch('https://api.x.com/2/chat/conversations/{id}/invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.x.com/2/chat/conversations/{id}/invite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action_signatures' => [
[
'encoded_message_event_detail' => '<string>',
'message_event_signature' => [
'public_key_version' => '<string>',
'signature' => '<string>',
'signature_version' => '<string>',
'message_signing_key_info_list' => [
[
'member_id' => '<string>',
'public_key_version' => '<string>',
'signing_public_key' => '<string>'
]
],
'signing_public_key' => '<string>'
],
'message_id' => '<string>',
'signature_payload' => '<string>'
]
],
'affiliate_user_id' => '<string>',
'decrypted_avatar_url' => '<string>',
'decrypted_title' => '<string>',
'invite_url' => '<string>',
'validity_duration_msec' => '<string>',
'validity_expiry_timestamp_msec' => '<string>',
'welcome_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.x.com/2/chat/conversations/{id}/invite"
payload := strings.NewReader("{\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"affiliate_user_id\": \"<string>\",\n \"decrypted_avatar_url\": \"<string>\",\n \"decrypted_title\": \"<string>\",\n \"invite_url\": \"<string>\",\n \"validity_duration_msec\": \"<string>\",\n \"validity_expiry_timestamp_msec\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.x.com/2/chat/conversations/{id}/invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"affiliate_user_id\": \"<string>\",\n \"decrypted_avatar_url\": \"<string>\",\n \"decrypted_title\": \"<string>\",\n \"invite_url\": \"<string>\",\n \"validity_duration_msec\": \"<string>\",\n \"validity_expiry_timestamp_msec\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"affiliate_user_id\": \"<string>\",\n \"decrypted_avatar_url\": \"<string>\",\n \"decrypted_title\": \"<string>\",\n \"invite_url\": \"<string>\",\n \"validity_duration_msec\": \"<string>\",\n \"validity_expiry_timestamp_msec\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"conversation_id": "<string>",
"expires_at": "<string>",
"group_avatar_url": "<string>",
"group_name": "<string>",
"invite_url": "<string>",
"token": "<string>",
"welcome_message": "<string>"
},
"errors": [
{
"detail": "<string>",
"resource_type": "<string>",
"title": "<string>",
"type": "https://api.x.com/2/problems/resource-not-found",
"parameter": "<string>",
"resource_id": "<string>",
"status": 123,
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}Authorizations
OAuth2UserTokenUserToken
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The ID of the group conversation, starting with g.
Pattern:
^g[0-9]{1,19}$Body
application/json
Cryptographic signatures for the action.
Show child attributes
Show child attributes
ID of the affiliate account to associate with the link.
Pattern:
^[0-9]{1,19}$Group avatar URL (https) to show on the invite preview.
Maximum string length:
2048Pattern:
^https://Group name to show on the invite preview.
Maximum string length:
1024Invite link built by the client, in the form https://x.com/i/chat/group_join/<conversation_id>/, where the token is exactly 10 letters, digits, '-' or '_'. The conversation segment must match the path ID. It is part of the signed payload, so it is required when action_signatures is sent.
Pattern:
^https://x\.com/i/chat/group_join/g[0-9]{1,19}/[A-Za-z0-9_-]{10}$How long the link stays valid, in milliseconds, from the time of the request. With action_signatures, send validity_expiry_timestamp_msec instead.
Pattern:
^[0-9]{1,19}$When the link expires, in epoch milliseconds. Must be in the future. If validity_duration_msec is also sent, the two must agree within a minute.
Pattern:
^[0-9]{1,19}$Message shown to people who open the link.
Maximum string length:
1024⌘I
Enable a Chat group invite link
curl --request POST \
--url https://api.x.com/2/chat/conversations/{id}/invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"affiliate_user_id": "<string>",
"decrypted_avatar_url": "<string>",
"decrypted_title": "<string>",
"invite_url": "<string>",
"validity_duration_msec": "<string>",
"validity_expiry_timestamp_msec": "<string>",
"welcome_message": "<string>"
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}/invite"
payload = {
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"affiliate_user_id": "<string>",
"decrypted_avatar_url": "<string>",
"decrypted_title": "<string>",
"invite_url": "<string>",
"validity_duration_msec": "<string>",
"validity_expiry_timestamp_msec": "<string>",
"welcome_message": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action_signatures: [
{
encoded_message_event_detail: '<string>',
message_event_signature: {
public_key_version: '<string>',
signature: '<string>',
signature_version: '<string>',
message_signing_key_info_list: [
{
member_id: '<string>',
public_key_version: '<string>',
signing_public_key: '<string>'
}
],
signing_public_key: '<string>'
},
message_id: '<string>',
signature_payload: '<string>'
}
],
affiliate_user_id: '<string>',
decrypted_avatar_url: '<string>',
decrypted_title: '<string>',
invite_url: '<string>',
validity_duration_msec: '<string>',
validity_expiry_timestamp_msec: '<string>',
welcome_message: '<string>'
})
};
fetch('https://api.x.com/2/chat/conversations/{id}/invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.x.com/2/chat/conversations/{id}/invite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action_signatures' => [
[
'encoded_message_event_detail' => '<string>',
'message_event_signature' => [
'public_key_version' => '<string>',
'signature' => '<string>',
'signature_version' => '<string>',
'message_signing_key_info_list' => [
[
'member_id' => '<string>',
'public_key_version' => '<string>',
'signing_public_key' => '<string>'
]
],
'signing_public_key' => '<string>'
],
'message_id' => '<string>',
'signature_payload' => '<string>'
]
],
'affiliate_user_id' => '<string>',
'decrypted_avatar_url' => '<string>',
'decrypted_title' => '<string>',
'invite_url' => '<string>',
'validity_duration_msec' => '<string>',
'validity_expiry_timestamp_msec' => '<string>',
'welcome_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.x.com/2/chat/conversations/{id}/invite"
payload := strings.NewReader("{\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"affiliate_user_id\": \"<string>\",\n \"decrypted_avatar_url\": \"<string>\",\n \"decrypted_title\": \"<string>\",\n \"invite_url\": \"<string>\",\n \"validity_duration_msec\": \"<string>\",\n \"validity_expiry_timestamp_msec\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.x.com/2/chat/conversations/{id}/invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"affiliate_user_id\": \"<string>\",\n \"decrypted_avatar_url\": \"<string>\",\n \"decrypted_title\": \"<string>\",\n \"invite_url\": \"<string>\",\n \"validity_duration_msec\": \"<string>\",\n \"validity_expiry_timestamp_msec\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"affiliate_user_id\": \"<string>\",\n \"decrypted_avatar_url\": \"<string>\",\n \"decrypted_title\": \"<string>\",\n \"invite_url\": \"<string>\",\n \"validity_duration_msec\": \"<string>\",\n \"validity_expiry_timestamp_msec\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"conversation_id": "<string>",
"expires_at": "<string>",
"group_avatar_url": "<string>",
"group_name": "<string>",
"invite_url": "<string>",
"token": "<string>",
"welcome_message": "<string>"
},
"errors": [
{
"detail": "<string>",
"resource_type": "<string>",
"title": "<string>",
"type": "https://api.x.com/2/problems/resource-not-found",
"parameter": "<string>",
"resource_id": "<string>",
"status": 123,
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}