API - How can we update only specific field of a form?

Hi @ukadakal this is a great question, and thanks for stopping by! When using the PATCH method, you’ll need to send the entire definition of the form, including the changes you want made. It isn’t possible to only update one field at the moment. :( 

Thank you @Liz and @picsoung. I have a follow up question. We are building an integration with Typeform. When user submits a form, we send selected answers to an external API. We pass the information we receive from this external API along with information from the first form to a second form (using redirect_after_submit_url) as hidden fields. But we also want to be able to display the information from the external API to the user in the second form. Is there a way to achieve this? We cannot seem to find a way display it because they come as hidden fields. 

@john.desborough that did the trick. Thank you!

Could I please get a coded example of a patch request for a valid field value such as the form title?

This is how I am trying to rename the form title (for Google Apps Script):

  var body = {'op' : 'replace',
              'path': '/title',
              'value': "succesfully_renamed"}

  var options = {
    "method" : "patch",
    "payload" : body,
    "headers": {'Authorization': {API_key},
            }
  }

  var url = 'https://api.typeform.com/forms/'+ {form_id}


  request = UrlFetchApp.fetch(url, options)

I get the following error when executing the code

Error	
Exception: Request failed for https://api.typeform.com returned code 403. Truncated server response: {"code":"INSUFFICIENT_PERMISSIONS","description":"not enough permissions to complete the action"} (use muteHttpExceptions option to examine full response)
renameSurvey	@ TypeFormAPI.gs:370

 

But the following get request is successful:

  var options = {
    "headers": {'Authorization': {API_key} }
  }

  var url = 'https://api.typeform.com/forms/'+ {form_id}


  request = UrlFetchApp.fetch(url, options)

Thank you in advance!

Hi @userresearcher 

I tried recreating the request in JavaScript.

1. Does your API key start with tfp_ and does it have correct permissions?
2. When you are sending Authorization header, you should send the value as Bearer <key>, not just the key itself.
3. When I send the body from your post, I get this error:

   {
     code: 'VALIDATION_ERROR',
     description: 'The payload is invalid.',
     details: [
       { code: 'WRONG_TYPE', description: 'should be array', in: 'body' }
     ]
   }

    

4. So I looked at the docs and we need to post the body as array:

   var body = [
     {
       'op' : 'replace',
       'path': '/title',
       'value': "I am your new form name"
     }
   ]

My final code in JavaScript that worked for me looks like this:

import fetch from 'node-fetch';

const API_KEY='tfp_***'

const id = '<form-id>'

const url = 'https://api.typeform.com/forms/' + id

const body = [
  {
    'op' : 'replace',
    'path': '/title',
    'value': "I am your new form name"
  }
] 

const options = {
    "method" : "patch",
    "body" : JSON.stringify(body),
    "headers": {
        'Authorization': `Bearer ${API_KEY}`, 
        'Content-Type': 'application/json'
    },
}

fetch(url, options).then(res => console.log('status', res.status)) // should be 'status 204'

Glad to hear it’s working, @userresearcher !