Update external API call

curl --request PATCH \
  --url 'https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Refund policy",
  "requestUrl": "https://help.example.com/refunds",
  "requestMethod": "GET",
  "requestHeaders": {
    "name": "Example",
    "value": "message"
  },
  "requestBody": {
    "name": "Example",
    "value": "message"
  },
  "responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
}'

const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer fini_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  'name': 'Refund policy',
  'requestUrl': 'https://help.example.com/refunds',
  'requestMethod': 'GET',
  'requestHeaders': {
    'name': 'Example',
    'value': 'message'
  },
  'requestBody': {
    'name': 'Example',
    'value': 'message'
  },
  'responseMapping': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
}
  )
});

const data = await response.json();

import requests

response = requests.patch(
    "https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public",
    headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
    json={
    "name": "Refund policy",
    "requestUrl": "https://help.example.com/refunds",
    "requestMethod": "GET",
    "requestHeaders": {
        "name": "Example",
        "value": "message"
    },
    "requestBody": {
        "name": "Example",
        "value": "message"
    },
    "responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
},
)

data = response.json()

{
  "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
  "name": "Lookup customer",
  "method": "GET",
  "url": "https://api.example.com/customers/{customerId}",
  "headers": {
    "Authorization": "Bearer ${apiToken}"
  },
  "saveFromResponse": {
    "plan": "customer.plan",
    "status": "customer.status"
  },
  "createdAt": "2026-07-28T08:55:32.000Z",
  "updatedAt": "2026-07-28T09:10:18.000Z"
}

PATCH

api-function-configs

{id}

public

curl --request PATCH \
  --url 'https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Refund policy",
  "requestUrl": "https://help.example.com/refunds",
  "requestMethod": "GET",
  "requestHeaders": {
    "name": "Example",
    "value": "message"
  },
  "requestBody": {
    "name": "Example",
    "value": "message"
  },
  "responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
}'

const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer fini_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  'name': 'Refund policy',
  'requestUrl': 'https://help.example.com/refunds',
  'requestMethod': 'GET',
  'requestHeaders': {
    'name': 'Example',
    'value': 'message'
  },
  'requestBody': {
    'name': 'Example',
    'value': 'message'
  },
  'responseMapping': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
}
  )
});

const data = await response.json();

import requests

response = requests.patch(
    "https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public",
    headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
    json={
    "name": "Refund policy",
    "requestUrl": "https://help.example.com/refunds",
    "requestMethod": "GET",
    "requestHeaders": {
        "name": "Example",
        "value": "message"
    },
    "requestBody": {
        "name": "Example",
        "value": "message"
    },
    "responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
},
)

data = response.json()

{
  "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
  "name": "Lookup customer",
  "method": "GET",
  "url": "https://api.example.com/customers/{customerId}",
  "headers": {
    "Authorization": "Bearer ${apiToken}"
  },
  "saveFromResponse": {
    "plan": "customer.plan",
    "status": "customer.status"
  },
  "createdAt": "2026-07-28T08:55:32.000Z",
  "updatedAt": "2026-07-28T09:10:18.000Z"
}

Updates one external API call record. The wire-format object is still called Data Step. All fields are optional; send only what you want to change.

Sensitive header and body values are preserved when you echo the masked "********" back. Send a new string to replace a secret. See Sensitive values and masking.

Headers

string

required

Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs write scope.

string

required

application/json

Path parameters

string

required

External API call step ID to update.

Body parameters

string

Updated step name.

string

Updated request URL. Supports ${fieldName} interpolation from inputs and ${stepId.responseMappingKey} interpolation from earlier external API calls. {{placeholder}} syntax is not supported.

string

Updated HTTP verb.

object

Updated request headers. Echo the masked value back to keep a stored secret.

object

Updated request body, with the same masking behavior as headers.

ResponseMapping

Updated output mapping. See ResponseMapping.

Response

Returns the updated Data Step with sensitive values masked.

curl --request PATCH \
  --url 'https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Refund policy",
  "requestUrl": "https://help.example.com/refunds",
  "requestMethod": "GET",
  "requestHeaders": {
    "name": "Example",
    "value": "message"
  },
  "requestBody": {
    "name": "Example",
    "value": "message"
  },
  "responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
}'

const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer fini_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  'name': 'Refund policy',
  'requestUrl': 'https://help.example.com/refunds',
  'requestMethod': 'GET',
  'requestHeaders': {
    'name': 'Example',
    'value': 'message'
  },
  'requestBody': {
    'name': 'Example',
    'value': 'message'
  },
  'responseMapping': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
}
  )
});

const data = await response.json();

import requests

response = requests.patch(
    "https://api-prod.usefini.com/v2/api-function-configs/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public",
    headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
    json={
    "name": "Refund policy",
    "requestUrl": "https://help.example.com/refunds",
    "requestMethod": "GET",
    "requestHeaders": {
        "name": "Example",
        "value": "message"
    },
    "requestBody": {
        "name": "Example",
        "value": "message"
    },
    "responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
},
)

data = response.json()

{
  "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
  "name": "Lookup customer",
  "method": "GET",
  "url": "https://api.example.com/customers/{customerId}",
  "headers": {
    "Authorization": "Bearer ${apiToken}"
  },
  "saveFromResponse": {
    "plan": "customer.plan",
    "status": "customer.status"
  },
  "createdAt": "2026-07-28T08:55:32.000Z",
  "updatedAt": "2026-07-28T09:10:18.000Z"
}

Errors

400 Bad Request

The body is malformed.

401 Unauthorized

The API key is missing, malformed, revoked, or invalid.

403 Forbidden

The API key does not include the write scope required for this route.

500 Internal Server Error

Fini failed while updating the Data Step, for example when the ID does not exist.

⌘I

​Headers

​Path parameters

​Body parameters

​Response

​Errors

Headers

Path parameters

Body parameters

Response

Errors