Add or toggle a reaction on a message
Adds or toggles a reaction through one channel-agnostic conversation endpoint.
/api/conversations/{id}/messages/{messageId}/reactionsAdds or toggles a reaction through one channel-agnostic conversation endpoint. The server resolves the authoritative conversation channel: Instagram, Messenger, and WhatsApp mutate the provider first, while local chat channels update Convor directly. API keys cannot create reactions. Visitor callers can only react inside their own conversations. The legacy userId body field is still required, but the server stores the authenticated caller ID instead of trusting the body value. The response includes a monotonically increasing revision that orders reaction snapshots delivered over HTTP and realtime.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
conversations:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Non-idempotent: Repeating this request may create duplicate work or side effects. After an ambiguous timeout, check the resource state before retrying.
Path Parameters
Resource identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidResource identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
Message reaction request.
TypeScript Definitions
Use the request body type in TypeScript.
Message reaction request.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "messageId": "7f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "reactions": [ { "emoji": "thumbs_up", "userId": "550e8400-e29b-41d4-a716-446655440000" } ], "revision": 1}Request examples
curl
curl --request POST \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages/11111111-1111-4111-8111-111111111111/reactions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"emoji": "thumbs_up",
"userId": "550e8400-e29b-41d4-a716-446655440000"
}'JavaScript
const response = await fetch("https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages/11111111-1111-4111-8111-111111111111/reactions", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"emoji": "thumbs_up",
"userId": "550e8400-e29b-41d4-a716-446655440000"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?