Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Blueprint - Fields

Update an integration blueprint field by ID

Use this endpoint to update an integration blueprint field related to the specified integration blueprint.

put/integration_blueprints/{integration_blueprint_id}/integration_blueprint_fields/{integration_blueprint_field_id}

Path parameters

integration_blueprint_idinteger required

The unique ID of the integration blueprint.

integration_blueprint_field_idinteger required

The unique ID of the integration blueprint field.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email

The email address of a registered Oneflow user.

Request body

custom_idstring nullable

A single unique customizable ID of the integration blueprint field.

descriptionstring nullable

The description of the integration blueprint field.

mapping_requiredboolean nullable

A flag to indicate if the mapping is required for integration blueprint field.

namestring nullable

The name of the integration blueprint field.

Example request

{
  "custom_id": "custom_id_integration_blueprint_field_1",
  "name": "Updated Integration Blueprint Field"
}

Response

Returns the updated integration blueprint field.

created_timestring datetime required
custom_idstring required
descriptionstring nullable required
idinteger required
mapping_requiredboolean required
namestring required
updated_timestring datetime nullable required