Update Campaign

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in TeleCMI dashboard. After getting the app id and secret, make a POST request to the below endpoint to update an existing Campaign and modify its mapped users.

Base URL

https://rest.telecmi.com/v3/campaign/update

Required Parameters

Takes the same parameters as Create Campaign, but with one additional required field:

Parameter Name	Type	Description
*campaign_id	String (UUID)	The UUID of the campaign to update.
*inet_no	Integer	The account identifier.
*secret	String (UUID)	Your app secret.
name	String	Name of the campaign.
active	Boolean	Status of the campaign.
timezone	String	Timezone offset (e.g., "+05:30").
start_date	String (Date)	Campaign start date (YYYY-MM-DD).
end_date	String (Date)	Campaign end date (YYYY-MM-DD).
start_time	String	Campaign start time (HH:MM:SS).
end_time	String	Campaign end time (HH:MM:SS).
users	Array of Strings	List of Agent IDs (max 100).
call_interval	Integer	10, 20, 30, 40, 50, 60, or 120.
ring_rule	String	"ring-all", "round-robin", etc.

Sample Response

{
  "code": 200,
  "msg": "Campaign updated successfully"
}

HTTP Status Codes

Status Code	Status Type	Description
200	Success	Campaign updated successfully
400	Error	Campaign Not Found
400	Error	Leads ID Not Found
400	Error	Lead already mapped to another campaign
400	Error	User already mapped to another campaign
404	Error	App Not Found
422	Error	Validation Failed (e.g., missing required field or invalid format)
500	Error	Internal Server Error

Note

The * marked parameter is mandatory.