---
title: Replace
slug: replace
docTags: 
createdAt: 2021-07-26T08:55:33.000Z
---

Replaces all the occurrence of a text in a given input text with a provided replacement text



| Property  | Description                                                                                                                                                                                    |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| oldString | This is the search pattern and can be an alphanumeric  text or a valid regex expression. Set the **regex** parameter to "yes" if this contains the search pattern in regular expression format |
| newString | The exact replacement value if the search pattern is found                                                                                                                                     |
| regex     | set "yes" if the oldString contains a valid regular expression pattern                                                                                                                         |








### API Definition

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://orca.pathfix.com/functions/text/replace",
  "name": "Replace API",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "6Ua3gYEJDn_OUz_X6BdXK",
        "code": "{\n\t\"output\": \"We need to totally replace our old furniture\"\n}",
        "language": "200"
      },
      {
        "id": "Rs0TQIhdH67vOg3-KV9a0",
        "code": "{\n    \"message\": \"error\"\n}",
        "language": "404"
      }
    ],
    "selectedLanguageId": "6Ua3gYEJDn_OUz_X6BdXK"
  },
  "examples": {
    "languages": [
      {
        "id": "kK9RskMqSJDpJ4sTO2zQF",
        "code": "{\r\n\t\"input\": \"We need to completely replace our old furniture\",\r\n\t\"oldString\": \"completely\",\r\n\t\"newString\": \"totally\"\r\n}",
        "language": "json"
      }
    ],
    "selectedLanguageId": "kK9RskMqSJDpJ4sTO2zQF"
  },
  "description": "Call the following API to replace values with replacement text",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  }
}
```
:::


API Definition

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://orca.pathfix.com/functions/text/replace",
  "name": "Replace API with Regex Search Pattern",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "6Ua3gYEJDn_OUz_X6BdXK",
        "code": "{\n\t\"output\": \"We need to completely replace our old furniture\"\n}",
        "language": "200"
      },
      {
        "id": "Rs0TQIhdH67vOg3-KV9a0",
        "code": "{\n    \"message\": \"error\"\n}",
        "language": "404"
      }
    ],
    "selectedLanguageId": "6Ua3gYEJDn_OUz_X6BdXK"
  },
  "examples": {
    "languages": [
      {
        "id": "kK9RskMqSJDpJ4sTO2zQF",
        "code": "{\r\n\t\"input\": \"We need to completely replace our old furniture ex-30293\",\r\n\t\"oldString\": \"ex-\\\\d+\",\r\n\t\"newString\": \"\",\r\n\t\"regex\":\"yes\"\r\n}",
        "language": "json"
      }
    ],
    "selectedLanguageId": "kK9RskMqSJDpJ4sTO2zQF"
  },
  "description": "Call the following API to replace values with replacement text",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  }
}
```
:::