Opt out a member or volunteer from SMS messaging

POST

/api/members/{id}/opt-out

const url = 'https://example.com/api/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/opt-out';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/opt-out \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Member successfully opted out of SMS

application/json

object

required

Unique identifier (UUID v4) for the resource.

string format: uuid

email

required

Primary email address.

string

fullName

Full legal or preferred name of the individual.

string

role

required

Assigned administrative user role (org_admin, partner_admin, staff).

string

Allowed values: org_admin partner_admin staff volunteer

partnerId

Unique identifier (UUID v4) for the assigned partner location facility.

string format: uuid

partnerName

Display name of the assigned partner location facility.

string

profiles

Assigned functional operational access profiles.

Array<string>

Allowed values: needs_processor intake_staff sms_communicator sms_manager email_phone_communicator pii_reader duplicate_resolver

isConfirmed

required

Flag confirming whether user email address has been verified.

boolean

phone

E.164 formatted contact phone number.

string

nullable

smsOptedOut

Flag indicating whether user is currently opted out of SMS notifications.

boolean

nullable

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "email": "[email protected]",
  "fullName": "Sarah Jenkins",
  "role": "org_admin",
  "partnerId": "20000000-0000-0000-0000-000000000002",
  "partnerName": "Community Food Pantry",
  "profiles": [
    "intake_staff",
    "kiosk_operator"
  ],
  "isConfirmed": true,
  "phone": "+17045550199",
  "smsOptedOut": false
}

400

Bad request

401

Unauthorized

403

Forbidden

404

Member not found