Update_contacts
- 16 Oct 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Update_contacts
- Updated on 16 Oct 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Put
/api/v1/{api_key}/campaigns/{campaign_id}/contacts
Update existing contacts/leads to an existing live campaign. Phone number is a mandatory parameter. Contact name, contact source, Contact URL for screen pop, Activity and priority for order call are optional parameters.
Path parameters
Example{user_api_key}
campaign_id
integer (int32) Required
Voiso campaign identifier
Example1234
Body parameters
contacts
Array of object (campaign_contact)
object
phoneNumber
string Required
Phone number to be added to campaign
Example1234
contactName
string
Name of the contact displayed on the agent's softphone
ExampleRichard Sanchez
contactSource
string
Source of the contact/lead
ExampleDimension C-137
contactURL
string
CRM URL for screen pop of contact record
ExampleMy CRM url
priority
integer (int32)
Lead call order, from 0 to 1000 (includes). Low priority is called early. Lead with unset priority have lowlest priority
Example2
isActive
boolean
Current lead activity, default true
Defaulttrue
ExampleFalse
Responses
201
All parameters are valid and the contacts update
object
duplicate_numbers
Array of string
Duplicate phone numbers
string
invalid_numbers
Array of string
Invalid phone number format
string
contacts
Array of string
Phone numbers successfully process to campaign
string
400
Update lead operation failed
example1
Error1
Campaign not found
{
"error": "Campaign not found"
}example2
Error2
Campaign type should be live
{
"error": "Campaign type should be live"
}example3
Error3
Maximum limit of 1000 contacts for each request
{
"error": "Maximum limit of 1000 contacts for each request"
}example4
Error4
Required contact field missing
{
"error": "Required contact field missing"
}Example{ "error": "Campaign not found" }
403
Invalid api_key
object
error
string
ExampleInvalid key
Was this article helpful?
