Fax Numbers

List Numbers

GET /fax_numbers — Returns all fax numbers provisioned for your account.

curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/fax_numbers" | jq

bash

curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/fax_numbers" | jq

curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/fax_numbers" | jq

Response

{
  "fax_numbers": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "number": "+15550100001",
      "callback_url": "https://example.com/webhooks/fax",
      "created_at": "2025-01-15T10:30:00.000Z",
      "client": null,
      "uri": "https://api.medsender.com/api/v2/fax_numbers/f47ac10b-58cc-4372-a567-0e02b2c3d479"
    }
  ]
}

JSON

{
  "fax_numbers": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "number": "+15550100001",
      "callback_url": "https://example.com/webhooks/fax",
      "created_at": "2025-01-15T10:30:00.000Z",
      "client": null,
      "uri": "https://api.medsender.com/api/v2/fax_numbers/f47ac10b-58cc-4372-a567-0e02b2c3d479"
    }
  ]
}

{
  "fax_numbers": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "number": "+15550100001",
      "callback_url": "https://example.com/webhooks/fax",
      "created_at": "2025-01-15T10:30:00.000Z",
      "client": null,
      "uri": "https://api.medsender.com/api/v2/fax_numbers/f47ac10b-58cc-4372-a567-0e02b2c3d479"
    }
  ]
}

Response Fields

Field	Description
id	Unique identifier (UUID) for this fax number
number	The fax number in E.164 format (e.g. +15550100001)
callback_url	Webhook URL for incoming fax notifications
created_at	When the number was provisioned (ISO 8601)
client	Client object if assigned, otherwise null
uri	API endpoint URL for this fax number

Provision Number

POST /fax_numbers — Provisions a new fax number in the specified area code.

Request Parameters (JSON body)

Parameter	Required	Description
fax_number.area_code	Yes	3-digit US area code (e.g. "415", "212")
fax_number.callback_url	No	Webhook URL for incoming fax notifications
fax_number.client_id	No	Client ID to assign this number to

export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" -d '{"fax_number":{"area_code":"415"}}' "$API_BASE/fax_numbers" | jq

bash

export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" -d '{"fax_number":{"area_code":"415"}}' "$API_BASE/fax_numbers" | jq

export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" -d '{"fax_number":{"area_code":"415"}}' "$API_BASE/fax_numbers" | jq

Response

{
  "fax_number": {
    "id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
    "number": "+15550100099",
    "callback_url": null,
    "created_at": "2025-01-15T10:35:00.000Z",
    "client": null,
    "uri": "https://api.medsender.com/api/v2/fax_numbers/a1b2c3d4-e5f6-4890-abcd-ef1234567890"
  }
}

JSON

{
  "fax_number": {
    "id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
    "number": "+15550100099",
    "callback_url": null,
    "created_at": "2025-01-15T10:35:00.000Z",
    "client": null,
    "uri": "https://api.medsender.com/api/v2/fax_numbers/a1b2c3d4-e5f6-4890-abcd-ef1234567890"
  }
}

{
  "fax_number": {
    "id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
    "number": "+15550100099",
    "callback_url": null,
    "created_at": "2025-01-15T10:35:00.000Z",
    "client": null,
    "uri": "https://api.medsender.com/api/v2/fax_numbers/a1b2c3d4-e5f6-4890-abcd-ef1234567890"
  }
}

Update Callback URL

PATCH /fax_numbers/:id — Updates the webhook callback URL for a fax number.

The :id parameter is the fax number's unique identifier (UUID).

curl -s -X PATCH -H "Authorization: Bearer sk_test_..." -H "Content-Type: application/json" -d '{"fax_number":{"callback_url":"https://example.com/webhooks/fax"}}' "https://api.medsender.com/api/v2/fax_numbers/YOUR_FAX_NUMBER_ID" | jq

bash

curl -s -X PATCH -H "Authorization: Bearer sk_test_..." -H "Content-Type: application/json" -d '{"fax_number":{"callback_url":"https://example.com/webhooks/fax"}}' "https://api.medsender.com/api/v2/fax_numbers/YOUR_FAX_NUMBER_ID" | jq

curl -s -X PATCH -H "Authorization: Bearer sk_test_..." -H "Content-Type: application/json" -d '{"fax_number":{"callback_url":"https://example.com/webhooks/fax"}}' "https://api.medsender.com/api/v2/fax_numbers/YOUR_FAX_NUMBER_ID" | jq

Response

{
  "fax_number": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "number": "+15550100001",
    "callback_url": "https://example.com/webhooks/fax",
    "created_at": "2025-01-15T10:30:00.000Z",
    "client": null,
    "uri": "https://api.medsender.com/api/v2/fax_numbers/f47ac10b-58cc-4372-a567-0e02b2c3d479"
  }
}

JSON

{
  "fax_number": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "number": "+15550100001",
    "callback_url": "https://example.com/webhooks/fax",
    "created_at": "2025-01-15T10:30:00.000Z",
    "client": null,
    "uri": "https://api.medsender.com/api/v2/fax_numbers/f47ac10b-58cc-4372-a567-0e02b2c3d479"
  }
}

{
  "fax_number": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "number": "+15550100001",
    "callback_url": "https://example.com/webhooks/fax",
    "created_at": "2025-01-15T10:30:00.000Z",
    "client": null,
    "uri": "https://api.medsender.com/api/v2/fax_numbers/f47ac10b-58cc-4372-a567-0e02b2c3d479"
  }
}