Record that someone agreed, with the wording they saw, or that they asked to stop
Recording opted_out stops every message to that address on that channel. Someone who replied STOP can only opt back in themselves, so recording opted_in for them answers 409 recipient_opted_out.
POST
https://app.softsolz.uk/api/v1/services/outreach/consentsRecent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Headers
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Idempotency-KeystringOptional idempotency key for safe retries.
Body Params
channelstringrequiredChannel the answer is for.
addressstringrequiredPhone number with country code, or an email address for the email channel.
statusstringrequiredTheir answer.
wordingstringThe wording the person agreed to. Required for opted_in.
Response
Response Body
consentobjectTheir latest answer for that channel.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/outreach/consents \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "channel": "sms", "address": "+447700900123", "status": "opted_in", "wording": "Yes, text me offers. Reply STOP to end."}'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 201
{ "data": { "consent": { "id": "880", "channel": "sms", "address": "+447700900123", "status": "opted_in", "source": "api", "wording": "Yes, text me offers. Reply STOP to end.", "page_url": null, "created_at": "2026-09-01T09:00:00.000Z" } }}