Update a fax number

Developing

PUT

/domains/{domain}/faxnumbers/{phonenumber}

Last modified:2026-10-08 14:06:55

OperationId:UpdateFaxNumber

Changes a fax number on the vendor holding it. Send only the fields to change; read-only fields in the body are ignored. Users can change their own numbers but not give them to someone else.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The fax number as stored.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴501

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/acme.example.com/faxnumbers/15551234567' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "inbound-email": "yes",
    "sharing": "dept:Sales"
}'

Response Example

200 - Success Example

{
    "phonenumber": "15551234567",
    "domain": "acme.example.com",
    "user": "1001",
    "vendor": "faxback",
    "enable-email": "yes",
    "enable-portal": "yes",
    "enable-ata": "no",
    "inbound-email": "attachment",
    "inbound-portal": "yes",
    "inbound-ata": "no",
    "notify-success-email": "no",
    "notify-success-ata": "no",
    "notify-failure-email": "yes",
    "notify-failure-ata": "no",
    "sharing": "no"
}

Modified at 2026-10-08 14:06:55

Read a fax number

Delete a fax number