Bulk Credentials

Bulk operations over Credentials

Delete several credentials

Delete several credentials in bulk.

SecuritybearerAuth
Request
query Parameters
filter[tag]
required
string

Filter by tag, required by bulk operations.

Responses
201

Successful response for Bulk credential requests

Response Schema: application/json
object
credentials
integer

Amount of credentials affected

422

Bad request

delete/actions/bulk/telephony_credentials
Request samples 
Response samples 
application/json
{
  • "data": {
    • "credentials": 0
    }
}
Update several credentials
Update several credentials in bulk.


SecuritybearerAuth 
Request 
query Parameters
filter[tag]
required
string
Filter by tag, required by bulk operations.


 
Request Body schema: application/json
required
Parameters to update credentials on bulk


amount
integer
Amount of credentials to be created. A single tag can hold at maximum 1000 credentials


 
connection_id
required
string
Identifies the connection this credential is associated with.


 
name
string
A default name for all credentials.


 
tag
required
string
Tags a credential for bulk operations. A single tag can hold at maximum 1000 credentials.


 
Responses 
201
Successful response for Bulk credential requests


Response Schema: application/json
object
 
credentials
integer
Amount of credentials affected


 
422
Bad request


patch/actions/bulk/telephony_credentials
Request samples 
application/json
{
  • "connection_id": "804252963366242252",
  • "name": "Default Name",
  • "tag": "My Credentials"
}
Response samples 
application/json
{
  • "data": {
    • "credentials": 0
    }
}
Creates several credentials
Creates several credentials in bulk.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Requested parameters to create credentials on bulk


amount
integer
Amount of credentials to be created. A single tag can hold at maximum 1000 credentials


 
connection_id
required
string
Identifies the connection this credential is associated with.


 
name
string
A default name for all credentials.


 
tag
required
string
Tags a credential for bulk operations. A single tag can hold at maximum 1000 credentials.


 
Responses 
201
Successful response for Bulk credential requests


Response Schema: application/json
object
 
credentials
integer
Amount of credentials affected


 
422
Bad request


post/actions/bulk/telephony_credentials
Request samples 
application/json
{
  • "connection_id": "804252963366242252",
  • "name": "Default Name",
  • "tag": "My Credentials"
}
Response samples 
application/json
{
  • "data": {
    • "credentials": 0
    }
}
Perform activate or deactivate action on all credentials filtered by the provided tag.
Perform activate or deactivate action on all credentials filtered by the provided tag. Activate action will change the status to active, making it possible to connect calls with the credential. Deactivate action will change the status to inactive, making it impossible to connect calls with the credential.


SecuritybearerAuth 
Request 
path Parameters
action
required
string
Identifies the action to be taken. Activate will change the status to active. Deactivate will change the status to inactive.


 Enum: "activate" "deactivate"  
query Parameters
filter[tag]
required
string
Filter by tag, required by bulk operations.


 
Responses 
200
Successful response for Bulk credential requests


Response Schema: application/json
object
 
credentials
integer
Amount of credentials affected


 
401
Unauthorized


404
Resource not found


422
Bad request


post/actions/{action}/telephony_credentials
Request samples 
Response samples 
application/json
{
  • "data": {
    • "credentials": 0
    }
}