Update Renewal Status: Funnel | Propexo

curl -X POST https://api.propexo.com/crm/v1/renewal-status/funnel \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "community_id": "string",
  "prospect_id": "string",
  "listing_id": "string",
  "show_renewal_card": true,
  "body_text": "string",
  "show_alert": true,
  "alert_body_text": "string",
  "alert_type": "WARNING",
  "allow_clickthrough": true,
  "header_text": "string",
  "subheader_text": "string",
  "icon_type": "SIGN"
}'

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "community_id": "string",
    "prospect_id": "string",
    "listing_id": "string",
    "show_renewal_card": true,
    "body_text": "string",
    "show_alert": true,
    "alert_body_text": "string",
    "alert_type": "WARNING",
    "allow_clickthrough": true,
    "header_text": "string",
    "subheader_text": "string",
    "icon_type": "SIGN"
  }
}

Update Renewal Status: Funnel

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

community_idstringRequired

The Propexo unique identifier for the community

prospect_idstringRequired

The Propexo unique identifier for the prospect

listing_idstringRequired

The Propexo unique identifier for the listing

show_renewal_cardbooleanRequired

Whether or not to show the renewal card

body_textstringRequired

The body text of the renewal

show_alertbooleanRequired

Whether or not to show the an alert for the renewal

alert_body_textstringRequired

The body text of the alert

alert_typeenumRequired

The type of the renewal alert

Allowed values:

allow_clickthroughbooleanRequired

Whether or not to allow click-through by the prospect to the renewal

header_textstringRequired

The text of the renewal header

subheader_textstringRequired

The text of the renewal sub-header

icon_typeenumRequired

The type of icon to use for the renewal alert. Funnel documents these

Response

Successful response

metaobject

resultobject

Authentication

Request

Response

Errors