add_api_example
Save a response example on an endpoint (for instance the 402 your handler returns for a declined card). Replaces the example with the same name, so it is safe to repeat.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | Example response body (any JSON). | |
| name | Yes | e.g. Card declined. | |
| path | No | Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}. | |
| method | No | HTTP method of the route, e.g. POST. Use with path instead of endpoint_id. | |
| status | Yes | ||
| headers | No | ||
| endpoint_id | No | Id of the endpoint. Alternative to method + path. | |
| status_text | No | ||
| collection_id | Yes | Id from list_api_collections. |