Skip to main content
POST
JavaScript
Availability: Automated and Assisted providers This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider.

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Path Parameters

benefit_id
string
required

Query Parameters

entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

Required array length: 1 element
Example:

Body

application/json
description
string

Updated name or description.

Response

OK

benefit_id
string<uuid>
required

The id of the benefit.

job_id
string<uuid>
required