Leads

Leads

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

    GET/leads
    POST/leads
    GET/leads/:id
    PATCH/leads/:id
    DELETE/leads/:id

    Retrieve undefined

    Request

    GET /leads
    export ICLOUDREADY_PERSONAL_API_KEY=[your personal api key]
    curl \
        -H "Authorization: Bearer $ICLOUDREADY_PERSONAL_API_KEY" \
        https://app.icloud-ready.com/leads

    Response

    No response

    Create undefined

    Request Parameters

    • leadInformation
      object
    • customer
      string
    • unitId
      string
    • leadOwner
      string
    • taskId
      string
    • promoId
      string
    • leadType
      string
    • leadSource
      string
    • status
      string
    • leadRating
      integer
    • history
      array
    • activityLog
      array
    • leadDescription
      string
    • notes
      array
    • documents
      array
    • idengagerRequestId
      string

    Request

    POST /leads
    export ICLOUDREADY_PERSONAL_API_KEY=[your personal api key]
    curl 
        -H 'Content-Type: application/json'\
        -H "Authorization: Bearer $ICLOUDREADY_PERSONAL_API_KEY" \
        https://app.icloud-ready.com/leads\
    	-d leadInformation="object"

    Response

    No response

    Retrieve undefined

    Path Parameters

    • id
      string

    Request

    GET /leads/:id
    export ICLOUDREADY_PERSONAL_API_KEY=[your personal api key]
    curl \
        -H "Authorization: Bearer $ICLOUDREADY_PERSONAL_API_KEY" \
        https://app.icloud-ready.com/leads/:id

    Response

    No response

    Update undefined

    Path Parameters

    • id
      string

    Request

    PATCH /leads/:id
    export ICLOUDREADY_PERSONAL_API_KEY=[your personal api key]
    curl -X PATCH \
        -H "Authorization: Bearer $ICLOUDREADY_PERSONAL_API_KEY" \
        https://app.icloud-ready.com/leads/:id

    Response

    No response

    Delete undefined

    Path Parameters

    • id
      string

    Request

    DELETE /leads/:id
    export ICLOUDREADY_PERSONAL_API_KEY=[your personal api key]
    curl  -X DELETE \
        -H "Authorization: Bearer $ICLOUDREADY_PERSONAL_API_KEY" \
        https://app.icloud-ready.com/leads/:id

    Response

    No response

    Questions?

    Was this page useful?