Skip to main content
Question

What should be set for ’external_id’ on BoxSign API

  • May 22, 2025
  • 4 replies
  • 53 views

Forum|alt.badge.img

When using Box Sign API, what should I set for the 'external_id'?

I want to use Google Apps Script to send a PDF with text inserted, based on data listed in a spreadsheet.

I have set up a template on the Box Sign web, placed a text box and signature field with an external identification ID in it, and saved it, but it does not work while execute via API.

I am beginning to suspect that I need to set something 'external_id', but I don't know what or how to set it.

I don't know if I can't use BoxSign as described above, or if my settings are wrong, but I was wondering if someone could help me.

 

*Template Setting 

BOX1_CZ0zM-FQJVkAF-uCfaj4vA.png

**Code on Google Apps Script

//Payload 
var payload =   {   
  source_files: [   {     
    id: “1234567890”,
        type: "file"    
  },   ],
    are_reminders_enabled: true,
    is_phone_verification_required_to_view: false,
    days_valid: 30,
     email_message: "Welcome to Our Company”,  
  email_subject: "Please Sign your hiring contract sheet",
     is_document_preparation_needed: false,
     external_id: "test01",
    signers: [   {     
  email: “test@test.co.jp,
        order: 1,
        password: "password",
        role: "signer",
      verification_phone_number: "+819012345678901" 
  },    ],
    prefill_tags: [   {    
    document_tag_id: "test01",
        text_value: "test"    
  },     {    
    document_tag_id: "test03",
        checkbox_value: false    
  },   ],
     parent_folder:       {      
    id: “12345678901”,
          type: "folder"     
  } 
};

4 replies

Forum|alt.badge.img

Hi, 

I asked around internally and it looks like we don't support templates via the API yet. This is something the team is working on tho. 

Alex, Box Developer Advocate


Forum|alt.badge.img

We hope this comes sooner rather than later. It's a game changer if we can set up a site wide template and use api's to create calls from that template. Any Idea of a timeframe?


Forum|alt.badge.img

Hi , Alex

 

Thanks a lot !

As Anthony said , if available template API , it's be game changer.

Do you know when release that API ?

 

Best Regards,


Forum|alt.badge.img

I'm also looking for this functionality. Having this option would definitely allow me to create some great web applications for my business users.