POST /api/v2/faxline
Assigns a fax line to a target. Target includes user and department. Depending on the chosen line type, the number will be taken from the company's reserved pool if there are available reserved numbers, otherwise numbers can be auto-assigned using a provided area code.
Added on January 13, 2025 for API v2.
Requires a company admin API key.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
target |
Object | Yes | |
target.target_id |
Integer | Yes |
The ID of the target to assign the fax line to. |
target.target_type |
String | Yes |
Type of the target to assign the fax line to. Possible values:
|
line |
Yes |
Line to assign. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.