Contacts
List Contacts
Parameters
Parameter Name
Required
Type
Description
Code Examples
# API Call Example (Shell)
curl -X GET "https://api.maiagent.ai/api/contacts/?inbox=550e8400-e29b-41d4-a716-446655440000&inboxes=example&page=1&pageSize=1&query=example&search=example" \
-H "Authorization: Api-Key YOUR_API_KEY"
# Please replace YOUR_API_KEY and verify the request data before execution.const axios = require('axios');
// Set request headers
const config = {
headers: {
'Authorization': 'Api-Key YOUR_API_KEY'
}
};
axios.get("https://api.maiagent.ai/api/contacts/?inbox=550e8400-e29b-41d4-a716-446655440000&inboxes=example&page=1&pageSize=1&query=example&search=example", config)
.then(response => {
console.log('Successfully received response:');
console.log(response.data);
})
.catch(error => {
console.error('An error occurred with the request:');
console.error(error.response?.data || error.message);
});Response Body
Create Contact
Code Example
Response Body
Get Contact Details
Parameters
Parameter Name
Required
Type
Description
Code Examples
Response Body
Update Contact
Parameters
Parameter Name
Required
Type
Description
Request Body
Field
Type
Required
Description
Code Examples
Response Body
Update Contact
Parameters
Parameter Name
Required
Type
Description
Request Body
Field
Type
Required
Description
Code Examples
Response Body
Delete Contact
Parameters
Parameter Name
Required
Type
Description
Code Examples
Response
Status Code
Description
Last updated
Was this helpful?
