put https://api.imiconnect.io/resources/v2/customerprofile
This API is used to update one or more customer profiles. You can update up to 1000 customers in a single request.
Request
The update profile request is specified as follows:
Request Headers
The following table describes the request headers:
| Request Header | Description |
|---|---|
| key | Client profile key |
| content-type | application/json |
##Request Examples
{
"Records": [{
"customerId": "1234568",
"Attributes": {
"email": "[email protected]",
"msisdn": "911278994640",
"name": "umtest"
}
}, {
"customerId": "1234569",
"Attributes": {
"email": "[email protected]",
"msisdn": "911278994642",
"name": "umtest"
}
}]
}
{
"Records": [{
"customerId": "1234568",
"Attributes": {
"email": "[email protected]",
"msisdn": "911278994640",
"name": "umtest"
}
}]
}
For data privacy and security reasons, the REST API is served over encrypted HTTPS. Standard HTTP is not supported.
Request Body
The following table describes the elements in the request body:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| customerid | String | Yes | Customer ID is a Client specific ID (such as CRN) to uniquely identify a customer. |
| attributes | String | Yes | String of key/value pairs to add or update. |
##Response Examples
{
"response": {
"code": "1001",
"description": "Queued",
"transid": "5657er77-53c8-42ac-8a58-ee6e062cae8a"
}
}
{
"response": {
"code": "1001",
"description": "Queued",
"transid": "5457ee77-53c8-41ac-9a58-rt6e062cae8a"
}
}
To know the status of the request
Use transid from the response and make a Get Profile status API call to get status of the request.
Response Codes
Following are the response codes this method may return:
| Response Code | Message | Description |
|---|---|---|
| 1000 | Queued | Returned when the request is queued. |
| 7000 | Invalid JSON | Returned when an invalid service key or profile key is provided in the request. |
| 7001 | Authentication failed | Returned when an invalid service key or profile key is provided in the request. |
| 7002 | Service Key Missing | Returned when the parameter key is missing in the message request. |
| 7003 | Mandatory parameters missing | Click here |
| 7006 | Internal error occurred | Returned when an internal error occurs. |
| 7010 | Source ip is not white listed | Returned when a request is sent from an IP that is not whitelisted in IMIconnect. |
| 7011 | Invalid Attribute Value | Returned when an invalid value is provided for the customer or app profile Attributes object. |
| 7012 | Batch size limit(100) exceeded | Returned when an API request exceeds the limit to create or update or delete using profile API. |
| 7014 | Customer not found | Returned when a customer does not exists to update or delete the profile. |