Leads API Reference
API Reference/Leads

Leads

For authentication instructions, see API overview.

Endpoints

get/api/v2/leads
post/api/v2/leads
get/api/v2/leads/:id
put/api/v2/leads/:id
patch/api/v2/leads/:id
post/api/v2/leads/:id/convert
delete/api/v2/leads/deleted/:id
post/api/v2/leads/:leadid/notes
put/api/v2/leads/:leadid/notes/:noteid
delete/api/v2/leads/:leadid/notes/:noteid
post/api/v2/leads/:leadid/activities
put/api/v2/leads/:leadid/activities/:activityId
delete/api/v2/leads/:leadid/activities/:activityId
get

List all leads

Returns a list of leads. The leads are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads

Response

No response schema
post

Create lead

Create lead. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • leadInformationobject
  • customerstring
  • unitIdstring
  • leadOwnerstring
  • taskIdstring
  • promoIdstring
  • leadTypestring
  • leadSourcestring
  • statusstring
  • leadRatinginteger
  • historyarray
  • activityLogarray
  • leadDescriptionstring
  • notesarray
  • documentsarray
  • idengagerRequestIdstring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads \
	-d 'leadInformation="object"' \
	-d 'customer="63a5b84c53e1218321c55572"' \
	-d 'unitId="63fdbdf3f41212bf5d749105"' \
	-d 'leadOwner="6429779bb76319ffe64832d9"' \
	-d 'taskId="6391eec6049e9c361e5801fe"' \
	-d 'promoId="promo123"' \
	-d 'leadType="new"' \
	-d 'leadSource="website"' \
	-d 'status="active"' \
	-d 'leadRating=4' \
	-d 'history=[]' \
	-d 'activityLog=[{"activityNumber":"1","activity":"Email sent","activityDate":"2023-04-19","logs":"Email sent to johndoe@example.com"}]' \
	-d 'leadDescription="Interested in purchasing a new property"' \
	-d 'notes=["Follow up next week","Send brochure"]' \
	-d 'documents=[{"uploadDate":"2023-04-18","fileUrl":"https://example.com/docs/doc1.pdf"},{"uploadDate":"2023-04-19","fileUrl":"https://example.com/docs/doc2.pdf"}]' \
	-d 'idengagerRequestId="request123"'

Response

No response schema
get

Retrieve lead

Returns a single lea, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the lead

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:id

Response

No response schema
put

Update lead

Path parameters

  • idstring

    ID of the lead

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:id

Response

No response schema
patch

Update lead soft

Update lead soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the lead

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:id

Response

No response schema
post

Create lead

Create lead. You need to pass through any required fields, and you can optionally pass through other fields.

Path parameters

  • idstring

    ID of the lead

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:id/convert

Response

No response schema
delete

Delete lead

Path parameters

  • idstring

    ID of the lead

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/deleted/:id

Response

No response schema
post

Create lead note

Create lead note. You need to pass through any required fields, and you can optionally pass through other fields.

Path parameters

  • leadidstring

    ID of the lead

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:leadid/notes

Response

No response schema
put

Update lead note

Path parameters

  • leadidstring

    ID of the lead

  • noteidstring

    ID of the note

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:leadid/notes/:noteid

Response

No response schema
delete

Delete lead note

Path parameters

  • leadidstring

    ID of the lead

  • noteidstring

    ID of the note

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:leadid/notes/:noteid

Response

No response schema
post

Create lead activity

Create lead activity. You need to pass through any required fields, and you can optionally pass through other fields.

Path parameters

  • leadidstring

    ID of the lead

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:leadid/activities

Response

No response schema
put

Update lead activity

Path parameters

  • leadidstring

    ID of the lead

  • activityIdstring

    ID of the activity

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:leadid/activities/:activityId

Response

No response schema
delete

Delete lead activity

Path parameters

  • leadidstring

    ID of the lead

  • activityIdstring

    ID of the activity

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/leads/:leadid/activities/:activityId

Response

No response schema