{"command":{"effect":"write","timeoutSeconds":30,"inputSchema":{"type":"object","description":"Record a customer's satisfaction rating for a conversation, with an optional free-text\nremark.\n\nFin decides *when* to ask for a rating — this reuses the CSAT settings on your Fin\nworkflow, not this API. When Fin asks, it fires a `csat_requested` event over webhooks\ncarrying the rating options to show the user. Present those options, then submit the\nuser's choice here.\n\nSubmitting the same rating again, with no new remark, is a no-op and stays successful,\nso an at-least-once client can safely retry. Submitting a *different* rating updates the\nstored rating while the update window is still open, and a first remark can be added to\nan already-rated survey. Once a remark has been recorded the rating is locked and can no\nlonger be changed.\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, go to **Settings > Integrations > Fin Agent API** in your workspace and tell us about your use case. Once access is granted, **Fin Agent API** appears under **Fin AI Agent > Deploy**.\n{% /admonition %}\n","properties":{"headers":{"type":"object","properties":{"Intercom-Version":{"$ref":"#/definitions/intercom_version","enum":["2.17"]}},"required":[],"additionalProperties":false},"body":{"type":"object","properties":{"conversation_id":{"type":"string","description":"Your external conversation ID — the same ID you started the conversation with, and the one echoed on the `csat_requested` event.","examples":["ext-123"]},"rating":{"type":"string","enum":["terrible","bad","ok","good","amazing"],"description":"The rating the user selected — one of the `key` values from the `csat_requested` event's options.","examples":["amazing"]},"remark":{"type":"string","description":"Optional free-text comment the user left alongside the rating. Can be added to an already-rated survey, but only once — the rating locks after a remark is recorded.","examples":["Fin solved my problem in seconds."]}},"required":["conversation_id","rating"],"examples":[{"conversation_id":"ext-123","rating":"amazing"}]}},"required":["body"],"additionalProperties":false,"definitions":{"intercom_version":{"description":"Intercom API version.</br>If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.","type":"string","enum":["1.0","1.1","1.2","1.3","1.4","2.0","2.1","2.2","2.3","2.4","2.5","2.6","2.7","2.8","2.9","2.10","2.11","2.12","2.13","2.14","2.15","2.16","2.17"],"examples":["2.17"]}}},"name":"Submit a CSAT rating","id":"intercom.submitfincsat","example":{"body":{"conversation_id":"ext-123","rating":"amazing"}},"maxRequests":1,"summary":false}}