- Home
- Models
- Sender
Sender
When workflows are performed, and an email or SMS is sent, this identifies who it is to be sent from.
Sender fields
Field |
Type |
Fillable |
Reference |
id
|
Integer
|
|
|
The unique ID to identify the sender
|
Sender relations
account,
available_incoming_users,
campaigns,
inbound_campaigns,
online_incoming_users,
queue_average_time,
queue_length,
users,
verified_domain,
Sender endpoints
GET List all Senders /senders toggle
Paramaters
There are no parameters for this endpoint
Example response
GET Return data for a specified Sender /senders/:id toggle
URL slugs
- id
-
Integer
The unique ID to identify the sender
Paramaters
There are no parameters for this endpoint
Example response
POST Save, or update a Sender /senders/:id? toggle
URL slugs
- id
-
Integer
The unique ID to identify the sender
Paramaters
- action
-
String
[No documentation available]
- email
-
Email
Nullable
The email address of the sender
- ext
-
String
Extension number
- forwarding_tel
-
String
Nullable
The telephone number to forward return calls to
- from_name
-
String
[No documentation available]
- inbound_on
-
String
[No documentation available]
- message
-
String
[No documentation available]
- name
-
String
Nullable
The From name of the sender
Required
- outbound_on
-
String
[No documentation available]
- queue_join_message
-
String
[No documentation available]
- queue_join_type
-
String
[No documentation available]
- queue_music
-
String
[No documentation available]
- queue_unavailable_message
-
String
[No documentation available]
- queue_unavailable_type
-
String
[No documentation available]
- queue_update_message
-
String
[No documentation available]
- queue_update_type
-
String
[No documentation available]
- queue_welcome_message
-
String
[No documentation available]
- queue_welcome_type
-
String
[No documentation available]
- record_calls
-
String
[No documentation available]
- tel
-
String
Nullable
The telephone number of the sender
- third_party_id
-
String
[No documentation available]
- type
-
String
The sender type
DELETE Delete a Sender /senders/:id toggle
URL slugs
- id
-
Integer
The unique ID to identify the sender
Paramaters
There are no parameters for this endpoint