Start an inbox sync
curl --request POST \
--url https://api.social-api.ai/v1/inbox/sync \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "acc_01H...",
"conversation_id": "6f1c..."
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({account_id: 'acc_01H...', conversation_id: '6f1c...'})
};
fetch('https://api.social-api.ai/v1/inbox/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.social-api.ai/v1/inbox/sync"
payload = {
"account_id": "acc_01H...",
"conversation_id": "6f1c..."
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"error": "",
"finished_at": "<string>",
"last_synced_at": "<string>",
"started_at": "<string>",
"state": "syncing",
"synced": 12
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}Inbox
Start an inbox sync
Refreshes an account’s inbox from the platform. Add conversation_id to refresh a single thread instead. Returns immediately: poll GET /inbox/sync until state leaves “syncing”. A sync already running for the same target is returned as-is rather than duplicated.
POST
/
inbox
/
sync
Start an inbox sync
curl --request POST \
--url https://api.social-api.ai/v1/inbox/sync \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "acc_01H...",
"conversation_id": "6f1c..."
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({account_id: 'acc_01H...', conversation_id: '6f1c...'})
};
fetch('https://api.social-api.ai/v1/inbox/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.social-api.ai/v1/inbox/sync"
payload = {
"account_id": "acc_01H...",
"conversation_id": "6f1c..."
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"error": "",
"finished_at": "<string>",
"last_synced_at": "<string>",
"started_at": "<string>",
"state": "syncing",
"synced": 12
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}Authorizations
Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...
Body
application/json
Sync target
Response
Sync started, or already running
Show child attributes
Show child attributes