API documentation

GET /api/v1/response_parsers
List Response Parsers

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be String
fulltext Optional	Search for any record that matches this text Validations: Must be String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id company_id outgoing_webhook_url_id name buyer_conversion_id zoho_crm_command_id description webhook_response_success_codes key value_path sortable_order value_formatter value_type value_expression record_token_filter_id record_token_filter_data_count record_token_filter_data Validations: Must be String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/response_parsers/new
Build Response Parser with defaults.

Params

Param name	Description Validations
outgoing_webhook_url_id Optional Blank Value Allowed	translation missing: en.api.response_parsers.outgoing_webhook_url_id Validations: Must be a valid foreign key reference to an Outgoing Webhook URL. Refer to: /api/docs/1.0/outgoing_webhook_urls
buyer_conversion_id Optional Blank Value Allowed	Buyer Conversion Validations: Must be a valid foreign key reference to an Buyer Conversion. Refer to: /api/docs/1.0/buyer_conversions
name Optional Blank Value Allowed	Name Validations: Must be String
description Optional Blank Value Allowed	Description Validations: Must be String
webhook_response_success_codes Optional Blank Value Allowed	Acceptable HTTP Status Codes Validations: Must be String
key Optional Blank Value Allowed	Token Key Validations: Must be String
value_path Optional Blank Value Allowed	Provide the path to extract a value. EG: lead.id Validations: Must be String
created_at Optional Blank Value Allowed	Created At Validations: Must be a valid time: 2024-04-18 04:59:41 +0000
updated_at Optional Blank Value Allowed	Updated At Validations: Must be a valid time: 2024-04-18 04:59:41 +0000

POST /api/v1/response_parsers
Create Response Parser.

Params

Param name	Description Validations
outgoing_webhook_url_id Optional Blank Value Allowed	translation missing: en.api.response_parsers.outgoing_webhook_url_id Validations: Must be a valid foreign key reference to an Outgoing Webhook URL. Refer to: /api/docs/1.0/outgoing_webhook_urls
buyer_conversion_id Optional Blank Value Allowed	Buyer Conversion Validations: Must be a valid foreign key reference to an Buyer Conversion. Refer to: /api/docs/1.0/buyer_conversions
name Optional Blank Value Allowed	Name Validations: Must be String
description Optional Blank Value Allowed	Description Validations: Must be String
webhook_response_success_codes Optional Blank Value Allowed	Acceptable HTTP Status Codes Validations: Must be String
key Optional Blank Value Allowed	Token Key Validations: Must be String
value_path Optional Blank Value Allowed	Provide the path to extract a value. EG: lead.id Validations: Must be String
created_at Optional Blank Value Allowed	Created At Validations: Must be a valid time: 2024-04-18 04:59:41 +0000
updated_at Optional Blank Value Allowed	Updated At Validations: Must be a valid time: 2024-04-18 04:59:41 +0000

GET /api/v1/response_parsers/:id
Get Response Parser by id.

PUT /api/v1/response_parsers/:id
Update Response Parser by id.

Params

Param name	Description Validations
outgoing_webhook_url_id Optional Blank Value Allowed	translation missing: en.api.response_parsers.outgoing_webhook_url_id Validations: Must be a valid foreign key reference to an Outgoing Webhook URL. Refer to: /api/docs/1.0/outgoing_webhook_urls
buyer_conversion_id Optional Blank Value Allowed	Buyer Conversion Validations: Must be a valid foreign key reference to an Buyer Conversion. Refer to: /api/docs/1.0/buyer_conversions
name Optional Blank Value Allowed	Name Validations: Must be String
description Optional Blank Value Allowed	Description Validations: Must be String
webhook_response_success_codes Optional Blank Value Allowed	Acceptable HTTP Status Codes Validations: Must be String
key Optional Blank Value Allowed	Token Key Validations: Must be String
value_path Optional Blank Value Allowed	Provide the path to extract a value. EG: lead.id Validations: Must be String
created_at Optional Blank Value Allowed	Created At Validations: Must be a valid time: 2024-04-18 04:59:41 +0000
updated_at Optional Blank Value Allowed	Updated At Validations: Must be a valid time: 2024-04-18 04:59:41 +0000

DELETE /api/v1/response_parsers/:id
Destroy Response Parser by id.