Imara Com API

Parameters

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/contacts?search=john&per_page=10' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {
      "id": 1,
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "phone": "+1234567890",
      "company": "Acme Inc",
      "lead_score": 75,
      "status": "active",
      "tags": [{"id": 1, "name": "VIP"}],
      "created_at": "2026-03-01T10:00:00Z"
    }
  ],
  "links": { "first": "...", "last": "...", "prev": null, "next": "..." },
  "meta": { "current_page": 1, "last_page": 5, "per_page": 10, "total": 48 }
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/contacts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"first_name":"Jane","email":"jane@example.com","company":"Acme"}'

Example Response

{
  "data": {
    "id": 42,
    "first_name": "Jane",
    "last_name": null,
    "email": "jane@example.com",
    "company": "Acme",
    "lead_score": 0,
    "status": "active",
    "tags": [],
    "created_at": "2026-03-22T14:30:00Z"
  }
}

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/contacts/42' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": {
    "id": 42,
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "conversations_count": 12,
    "deals_count": 3
  }
}

Parameters

Example Request

curl -X PUT 'https://imara.digifrica.com/api/v1/contacts/42' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"lead_score":90,"status":"active"}'

Example Response

{
  "data": {
    "id": 42,
    "first_name": "Jane",
    "lead_score": 90,
    "status": "active"
  }
}

Example Request

curl -X DELETE 'https://imara.digifrica.com/api/v1/contacts/42' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Example Response

204 No Content

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/contacts/import' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -F 'file=@contacts.csv'

Example Response

{
  "data": {
    "imported": 142,
    "skipped": 3,
    "errors": ["Row 15: invalid email 'not-an-email'"]
  }
}

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/contacts/export' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -o contacts.csv

Example Response

Binary CSV file stream

Parameters

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/conversations?status=open' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {
      "id": 1,
      "subject": "Billing question",
      "status": "open",
      "channel": "email",
      "contact": {"id": 5, "email": "user@example.com"},
      "assigned_to": {"id": 2, "name": "Agent Smith"},
      "last_message_at": "2026-03-22T09:30:00Z"
    }
  ],
  "meta": {"current_page": 1, "total": 24}
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/conversations/1/reply' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"body":"Thanks for reaching out! We will look into this."}'

Example Response

{
  "data": {
    "id": 145,
    "conversation_id": 1,
    "body": "Thanks for reaching out! We will look into this.",
    "type": "reply",
    "created_at": "2026-03-22T14:30:00Z"
  }
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/conversations/1/assign' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"user_id":3}'

Example Response

{
  "data": {"id": 1, "assigned_to": {"id": 3, "name": "Agent Jones"}}
}

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/conversations/1/close' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Example Response

{
  "data": {"id": 1, "status": "closed"}
}

Parameters

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/campaigns?status=sent' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {
      "id": 1,
      "name": "March Newsletter",
      "subject": "What is new in March",
      "status": "sent",
      "sent_count": 1250,
      "open_rate": 34.5,
      "click_rate": 8.2,
      "created_at": "2026-03-01T08:00:00Z"
    }
  ]
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/campaigns' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"April Promo","subject":"Special offer inside","html_body":"<h1>Hello!</h1>"}'

Example Response

{
  "data": {"id": 15, "name": "April Promo", "status": "draft"}
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/campaigns/15/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

Example Response

{
  "data": {"id": 15, "status": "sending"}
}

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/workflows' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {"id": 1, "name": "Welcome Series", "status": "active", "trigger": "contact.created", "executions_count": 342}
  ]
}

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/workflows/1/activate' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Example Response

{"data": {"id": 1, "status": "active"}}

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/workflows/1/pause' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Example Response

{"data": {"id": 1, "status": "paused"}}

Parameters

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/knowledge-base' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {"id": 1, "title": "Product FAQ", "type": "file", "file_size": 245760, "chunks_count": 24, "created_at": "2026-03-10T12:00:00Z"}
  ]
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/knowledge-base' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -F 'title=Return Policy' \
  -F 'file=@return-policy.pdf'

Example Response

{
  "data": {"id": 5, "title": "Return Policy", "status": "processing"}
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/knowledge-base/scrape' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com/help"}'

Example Response

{
  "data": {"id": 6, "title": "Help Center", "type": "url", "status": "processing"}
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/ai/generate-reply' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"conversation_id":1,"tone":"professional"}'

Example Response

{
  "data": {
    "reply": "Thank you for contacting us regarding your billing inquiry...",
    "tokens_used": 245,
    "model": "gpt-4"
  }
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/ai/analyze-sentiment' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"text":"I am very frustrated with the late delivery"}'

Example Response

{
  "data": {
    "sentiment": "negative",
    "score": -0.78,
    "emotions": ["frustration", "disappointment"],
    "urgency": "high"
  }
}

Parameters

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/analytics/overview?period=30d' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": {
    "conversations": {"total": 524, "open": 38, "avg_resolution_hours": 4.2},
    "contacts": {"total": 12500, "new_this_period": 320},
    "campaigns": {"sent": 8, "avg_open_rate": 32.1, "avg_click_rate": 6.8},
    "ai": {"replies_generated": 186, "tokens_used": 45200}
  }
}

Parameters

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/analytics/team' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {"user_id": 2, "name": "Agent Smith", "conversations_handled": 142, "avg_response_minutes": 12, "satisfaction_score": 4.6}
  ]
}

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/tags' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {"id": 1, "name": "VIP", "color": "#8B5CF6", "contacts_count": 42},
    {"id": 2, "name": "Lead", "color": "#3B82F6", "contacts_count": 198}
  ]
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/tags' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Enterprise","color":"#EF4444"}'

Example Response

{
  "data": {"id": 3, "name": "Enterprise", "color": "#EF4444"}
}

Example Request

curl -X DELETE 'https://imara.digifrica.com/api/v1/tags/3' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Example Response

204 No Content

Example Request

curl -X GET 'https://imara.digifrica.com/api/v1/canned-responses' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

Example Response

{
  "data": [
    {"id": 1, "title": "Greeting", "shortcut": "/greet", "body": "Hello! How can I help you today?"}
  ]
}

Parameters

Example Request

curl -X POST 'https://imara.digifrica.com/api/v1/canned-responses' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"title":"Thanks","shortcut":"/thanks","body":"Thank you for your patience!"}'

Example Response

{
  "data": {"id": 5, "title": "Thanks", "shortcut": "/thanks", "body": "Thank you for your patience!"}
}