Colleurs Server API


Endpoint:/

Get POI collections

GET
/
/colleurs/getPOICollections

Retrieve POI collections for a specific user

Get POI collectionsquery Parameters

  • identifier
    string
    required

    User identifier

Get POI collectionsResponses

    • success
      boolean
      optional
    • records
      object[]
      optional

Create or update POI collections

PATCH
/
/colleurs/upsertPOICollections

Insert or update POI collections for a user

Create or update POI collectionsquery Parameters

  • identifier
    string
    required

    User identifier

Create or update POI collectionsRequest Body

  • records
    object[]
    optional

Create or update POI collectionsResponses

    • success
      boolean
      optional
    • records
      object[]
      optional

Share a POI collection

PATCH
/
/colleurs/sharePOICollection

Share a POI collection with other users

Share a POI collectionquery Parameters

  • identifier
    string
    required

    User identifier

Share a POI collectionRequest Body

  • records
    object[]
    optional
  • shareWithIds
    string[]
    optional

    IDs of users to share the collection with

Share a POI collectionResponses

    • success
      boolean
      optional
    • message
      string
      optional

Get all POIs for a user

GET
/
/colleurs/getAllMyPOIs

Retrieve all POIs associated with a specific user

Get all POIs for a userquery Parameters

  • identifier
    string
    required

    User identifier

Get all POIs for a userResponses

    • success
      boolean
      optional
    • records
      object[]
      optional

Get specific POIs

GET
/
/colleurs/getPOIs

Retrieve specific POIs by their IDs

Get specific POIsquery Parameters

  • poiids
    string
    required

    Comma-separated list of POI IDs

Get specific POIsResponses

    • success
      boolean
      optional
    • records
      object[]
      optional

Create or update POIs

PATCH
/
/colleurs/upsertPOIs

Insert or update POIs with image downgrading (500px width)

Create or update POIsquery Parameters

  • identifier
    string
    required

    User identifier

Create or update POIsRequest Body

  • records
    object[]
    optional

Create or update POIsResponses

    • success
      boolean
      optional
    • records
      object[]
      optional

Submit a signup request

POST
/
/colleurs/signupRequest

Create a new user registration request

Submit a signup requestquery Parameters

  • identifier
    string
    required

    User tracking identifier

Submit a signup requestRequest Body

  • email
    string

    User's email address

    Format: email
  • name
    string
    optional

    User's full name

  • company
    string
    optional

    User's company or organization

Submit a signup requestResponses

    • success
      boolean
      optional
    • message
      string
      optional

Insert records into Salesforce

PUT
/
/salesforce/insert

Create new records in Salesforce

Insert records into SalesforceRequest Body

  • sobject
    string
    optional

    The Salesforce object type

  • records
    object[]
    optional

Insert records into SalesforceResponses

    • success
      boolean
      optional
    • records
      object[]
      optional

Upsert records in Salesforce

PATCH
/
/salesforce/upsert

Create or update records in Salesforce

Upsert records in SalesforceRequest Body

  • sobject
    string
    optional

    The Salesforce object type

  • externalIdField
    string
    optional

    External ID field name for matching

  • records
    object[]
    optional

Upsert records in SalesforceResponses

    • success
      boolean
      optional
    • records
      object[]
      optional

Query Salesforce records

GET
/
/salesforce/query

Execute SOQL queries against Salesforce

Query Salesforce recordsquery Parameters

  • soql
    string
    required

    SOQL query string

Query Salesforce recordsResponses

    • success
      boolean
      optional
    • records
      object[]
      optional
    • totalSize
      integer
      optional
    • done
      boolean
      optional

Make a direct request to Salesforce

GET
/
/salesforce/request

Send a custom request to a Salesforce API endpoint

Make a direct request to Salesforcequery Parameters

  • url
    string
    required

    The URL to request from Salesforce

Make a direct request to SalesforceResponses

    object

Delete Salesforce records

GET
/
/salesforce/delete

Remove records from Salesforce

Delete Salesforce recordsquery Parameters

  • id
    string
    required

    ID of the record to delete

Delete Salesforce recordsResponses

    • success
      boolean
      optional