apimo™

Webservice & API

Welcome to our API dedicated to Real Estate providers, you will find all the details of a real estate agency with its products, contacts and settings. Depending on your rights you can also send some information such as leads.

Partners

Request a free trial

Contact us

Agencies/actions

Available methods

HTTP method Path Function
post /agencies/{agency_id}/actions Create a new action
put /agencies/{agency_id}/actions/{action_id} Update an action

post Create a new action /agencies/{agency_id}/actions

Path parameters

  • agency_id  The unique id for the real estate agency

Request body parameters

  • user  Unique ID of the user (required)
  • type  Action type
  • method  Action method
  • date  Date of the action (format YYYY-MM-DD) (required)
  • start_at  Start time (HH:MM)
  • end_at  End time (HH:MM)
  • contact  Unique ID of the contact
  • properties  Node of properties ID
  • subject  Subject content of the action
  • content  All content of the action
  • referral  Origin of the action
  • subreferral  Sub-origin of the action

Response body

  • id  Unique ID

Example request

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/actions' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/actions');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 29 May 2020 07:59:12 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"19344239"}

put Update an action /agencies/{agency_id}/actions/{action_id}

Path parameters

  • agency_id  The unique id for the real estate agency
  • action_id  The unique id of the action to update

Request body parameters

  • user  Unique ID of the user (required)
  • type  Action type
  • method  Action method
  • date  Date of the action (format YYYY-MM-DD) (required)
  • start_at  Start time (HH:MM)
  • end_at  End time (HH:MM)
  • contact  Unique ID of the contact
  • properties  Node of properties ID
  • subject  Subject content of the action
  • content  All content of the action
  • referral  Origin of the action
  • subreferral  Sub-origin of the action

Response body

  • id  Unique ID

Example request

Console
PHP
curl --request PUT \
--url 'https://api.apimo.pro/agencies/{agency_id}/actions/{action_id}' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/actions/{action_id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 29 May 2020 07:59:12 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"19344239"}