me.setSmsConsent

Grant or revoke Doing Work SMS alerts and check-in consent for the signed-in person. Hosted page only; an agent key cannot opt in for someone.

WhoHosted page only (a person does it in the browser)
RESTPOST /v1/me/sms-consent
MCP toolNot an MCP tool
Writesyes, send an Idempotency-Key
AreaShop

When to use it

Grant or revoke Doing Work SMS alerts and check-in consent for the signed-in person. Hosted page only; an agent key cannot opt in for someone.

What to tell the owner

Send the person the link. They finish this step themselves on the page; you never do it for them.

Input

FieldTypeRequired
phonestringno
consentstring (one of yes, no)yes
scopestring (one of all, operational, nudges)no
sourcestring (one of web_start, web_invite, web_account, api)no

Example

POST https://doingwork.work/v1/me/sms-consent
content-type: application/json
Idempotency-Key: 3f1c...

{
  "consent": "yes"
}

Output

FieldTypeAlways there
consent_idstring (uuid)yes
person_idstring (uuid)yes
phone_e164stringyes
statusstringyes
scopestringyes
text_versionstringyes
captured_atstring (date-time)yes
{
  "consent_id": "00000000-0000-4000-8000-000000000000",
  "person_id": "00000000-0000-4000-8000-000000000000",
  "phone_e164": "...",
  "status": "...",
  "scope": "...",
  "text_version": "...",
  "captured_at": "..."
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.