This API method is used to update a contact created in the user's workspace.
| Parameter | Required | Type | Description |
|---|---|---|---|
| apikey | yes | string | Your authorized API key |
| secret | yes | string | Your authorized secret key |
| user_id | yes | string | Unique ID of the user |
| business_id | yes | string | Unique ID of the business |
| tags | yes | string | Unique ID of the tag |
| first_name | yes | string | First name of the contact |
| last_name | no | string | Last name of the contact |
| phone number | yes | number | Phone number of the contact |
| email address | yes | string | Email address of the contact |
| company | no | string | Name of the company |
| profile_image | no | string | Profile image for contact |
| contact_id | yes | string | Unique ID of the contact |
{
"status": "success",
"status_code": 200,
"message": "Contact updated successfully",
"result": {
"_id": "xxxxxxxxxxxxxxxx"
}
}
| Error Code | Description |
|---|---|
| 204 | No Record Found |
| 802 | Tag Not Found |
| 721 | A valid phone number is required |
| 782 | Invalid country code |
| 409 | The phone number / email address already exist in another contact. |
| 701 | User id parameter required |
| 702 | User id required |
| 701 | Business id parameter required |
| 702 | Business id required |
| 613 | Invalid user and business |
{
"status": "no_record",
"status_code": 204,
"message": "No record found",
"result": {
"response_type": "No Content"
}
}
{
"error": {
"errors": [
{
"reason": "Invalid Tags",
"message": "Tag id(s) that you provided doesn't match in our records."
}
],
"code": 802,
"error_type": "tag_not_found"
}
}
{
"error": {
"errors": [
{
"reason": "Length required",
"message": "A valid phone number is required."
}
],
"code": 721,
"error_type": "phone_length_error",
"number_format": "+1-415123456,+1-415654321,etc..."
}
}
{
"error": {
"errors": [
{
"reason": "Invalid Country",
"message": "Invalid country code provided."
}
],
"code": 782,
"error_type": "invalid_code"
}
}
{
"status": "conflict",
"status_code": 409,
"message": "The phone number / email address already exist in another contact.",
"result": {
"details": {
"_id": "5ac7485fc80b4c57d6ace047",
"phone_number": [
"1-4452369363"
],
"email_address": [
"venkatrock123@gmail.com"
]
},
"response_type": "Conflict"
}
}
{
"error": {
"reason": "parameter missing",
"message": "User id parameter required",
"field_name": "user_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "required field",
"message": "User id is required",
"code": 702,
"error_type": "required"
}
}
{
"error": {
"reason": "parameter missing",
"message": "Business id parameter required",
"field_name": "business_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "required field",
"message": "Business id required",
"code": 702,
"error_type": "required"
}
}
{
"error": {
"reason": "Invalid user and business",
"message": "The business and user id combination that you provided doesn't match in our record",
"code": 613,
"error_type": "invalid_user_business"
}
}
Loading please wait...
