Allows a List to be updated, activated, or deactivated in a Convoso account.
Endpoint:
POST https://api.convoso.com/v1/list/insert
đź”’ Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | API key for authentication. |
| list_id | integer | Yes | The ID for the list that should be updated. |
| name | string | No | A new name for the list. Must be at least 10 characters long. |
| campaign_id | string | No | The new campaign the list should be assigned to. |
| description | string | No | The new description of the list. 0-255 Characters. |
| status | string | No | The status of the list. Default = 1 (Active) |
Example Request
POST https://api.convoso.com/v1/lists/update?auth_token=your_auth_token&name=MyNewListName&campaign_id=&description=NewListDescription&status=1
Response Format (JSON)
{
"success": true,
"data": {
"list_id": 2807
}
}Response Field Definitions
Top-Level Data Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Identifies if the API was executed successfully |
| data | object | Data Object |
Data Object
| Field | Type | Description |
|---|---|---|
| list_id | integer | List identifier assigned to the newly created list |