Managing Contact Methods

Contact methods are created and managed through the beeps web UI at Settings > Profile. Your signup email is automatically added as a verified contact method.

The SDK and API provide read and delete access for programmatic management.

Creating a Contact Method

const result = await client.contactMethod.create({
  transport: "sms",
  value: "+15555550100",
});

Or via the API:

POST /v0/contact-methods
{ "transport": "sms", "value": "+15555550100" }

userId is optional everywhere on this page — it defaults to the user who created the access token, which is what you want when managing your own contact methods (beeps contact-method add in the CLI). Creating an SMS method sends the verification text automatically; reply YES to verify. Re-send it with client.contactMethod.sendVerification(id) or POST /v0/contact-methods/:id/send-verification.

Listing Contact Methods

const methods = await client.contactMethod.list({
  userId: "usr_alice",
});

console.log(`Found ${methods.length} contact methods`);

methods.forEach((method) => {
  console.log(`- ${method.transport}: ${method.value}`);
  console.log(`  Verified: ${method.verified}`);
});

Filter by Transport Type

const methods = await client.contactMethod.list({
  userId: "usr_alice",
});

const emailMethods = methods.filter((m) => m.transport === "email");
const smsMethods = methods.filter((m) => m.transport === "sms");

console.log(`Emails: ${emailMethods.length}`);
console.log(`SMS: ${smsMethods.length}`);

curl -X GET "https://api.beeps.dev/v0/contact-methods?userId=usr_alice" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

{
  "contactMethods": [
    {
      "id": "cm_abc123",
      "userId": "usr_alice",
      "transport": "email",
      "value": "alice@example.com",
      "verified": true,
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z",
      "deletedAt": null
    },
    {
      "id": "cm_def456",
      "userId": "usr_alice",
      "transport": "sms",
      "value": "+14155551234",
      "verified": false,
      "createdAt": "2025-01-15T11:00:00Z",
      "updatedAt": "2025-01-15T11:00:00Z",
      "deletedAt": null
    }
  ]
}

Deleting a Contact Method

const result = await client.contactMethod.delete("cm_abc123", {
  userId: "usr_alice",
});

console.log("Deleted successfully:", result.success);

Safe Method

const result = await client.contactMethod.deleteSafe("cm_abc123", {
  userId: "usr_alice",
});

if (result.error) {
  console.error("Failed to delete:", result.error.message);
} else {
  console.log("Deleted:", result.data.success);
}

curl -X DELETE "https://api.beeps.dev/v0/contact-methods/cm_abc123?userId=usr_alice" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

{
  "success": true
}

Type Definitions

ContactMethod

type ContactMethod = {
  id: string;
  userId: string;
  transport: string;
  value: string;
  verified: boolean;
  createdAt: string;
  updatedAt: string;
  deletedAt: string | null;
};

ListContactMethodsParams

type ListContactMethodsParams = {
  userId: string;
};

DeleteContactMethodParams

type DeleteContactMethodParams = {
  userId: string;
};

Troubleshooting

No one receiving notifications? See Troubleshooting - No One Is Notified.