Modify a link's data retrieval

PATCH {{baseUrl}}/api/links/:id/

Documentation šŸ“–

Modify the data retrieval settings for a specific link. For more details, make sure to check out our API reference.

At present you can:

  • Change a link's access mode fromĀ singleĀ toĀ recurrentĀ or fromĀ recurrentĀ toĀ single.

  • Modify the historical resources you want to retrieve for the link (fetch_resources).

Changing a link'sĀ access_mode

When you change a link fromĀ singleĀ toĀ recurrent, the next day a historical update of the core resources for the link is triggered (resulting in you receivingĀ historical_updateĀ webhooks for the link). You are billed for these historical updates.

ModifyingĀ fetch_resources

If you only modify theĀ fetch_resourcesĀ for a link, this will not trigger a historical update. In order to trigger a historical update for the link, you must change theĀ access_modeĀ toĀ recurrent.

Request Body

{"access_mode"=>"choose_single_or_recurrent", "fetch_resources"=>["ARRAY", "OF", "RESOURCES"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring