AddCustomField throws an error when required and editor parameters are not explicitly passed.

[Framinus]

The AddCustomField is supposed to have two mandatory parameters - name and value - and two optional parameters, "editor" and "required".

When only the "name" and "value" parameters are passed into AddCustomField, the following error gets thrown:

Unhandled Exception: HelloSign.BadRequestException: custom_fields with a required parameter must specify an editor parameter.

I think this may have to do with how the values of the required and editor parameters are being set by the SDK in hellosign-dotnet-sdk/src/HelloSign/Models/TemplateSignatureRequest.cs Line 62:

public void AddCustomField(string key, string value, string editor = null, bool required = false)

I am wondering if the error is getting thrown because the required parameter is being submitted, even if the value of it is submitted as false?

[djschwarz]

I am getting the same behavior.

[djschwarz]

I added "Me" as a signer and I no longer get the error message.

[meljason]

I added "Me" as a signer and I no longer get the error message.

@djschwarz Hello, could you elaborate more on that? How do you add "me" as a signer?

[djschwarz]

Hi Jason, Here is the information I sent in to HelloSign when I reported the issue: Hi James, I was able to get it working. It seems I needed to add myself as a Signer even though there wasn't anything for me to sign. Once I added myself as a signer it worked as expected. You can close this ticket. Thanks. Hi James, I stripped down the original document, uploaded it with only one custom field that is filled by me when sending and I am getting the same error. It looks like this issue was reported here: https://github.com/hellosign/ hellosign-dotnet-sdk/issues/68 Any help would be appreciated. Thanks in advance. On Tue, Mar 5, 2019 at 6:04 PM Dan Schwarz <dan@djschwarz.com> wrote: Hi James, I changed the project to use 4.6.2 and I am able to get a list of my templates using the API. I am having another issue now. I am using a template (efa9252337989e78edd9c09ae970463f94262f2b) and I am trying to get the custom fields working but I am not having any luck. I started by using the field label and the api id. Syntax 1: request.AddCustomField("First", doc.First); and got the following error: "custom_fields with a required parameter must specify an editor parameter." Syntax 2: request.AddCustomField("b0d6da_11", doc.First); and got the following error: "custom_fields with a required parameter must specify an editor parameter." Syntax 3: Then I tried adding the rest of the parameters: request.AddCustomField("b0d6da_11", doc.First, "Me", false); and got the following error: "All custom_fields editor roles must match a signer role." Can you give me any direction on the API? I use Syntax 1 last year without any issue, but I am getting hung up. Thanks in advance. Attachment(s)

…

On Wed, Mar 3, 2021 at 2:24 PM Jason Chong ***@***.***> wrote: I added "Me" as a signer and I no longer get the error message. @djschwarz <https://github.com/djschwarz> Hello, could you elaborate more on that? How do you add "me" as a signer? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#68 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAOTZ7R3S6NPMWU22H6RA43TB2LHRANCNFSM4GYOSZ2Q> .

-- Best regards, Dan Schwarz Email: dan@djschwarz.com Mobile: 651-226-5223 Web: DJSchwarz.com <http://djschwarz.com/> http://djschwarz.com/

[elminson]

request.addSigner("email@gmail.com", "client_name", "Me"); // You are missing the last param on addSigner
request.AddCustomField('b0d6da_11', doc.First, "Me");

you need to add the last param as signer and then use it in each AddCustomField

cc: @djschwarz

[raedbadran]

I just started getting this error out of the blue today. Did HelloSign push changes today? Any help or insight is appreciated.

[najens]

Just started getting this error today as well with a php-sdk at 3:21pm MDT, so there was likely a HelloSign API release today that started causing this to happen.

[Framinus]

@raedbadran and @najens - I no longer work at HelloSign. I would recommend opening a ticket with the API Support team. But yes, it looks like there was a release today: https://status.hellosign.com/#past-incidents

[raedbadran]

@najens and @Framinus Thank you very much. Was going a bit crazy over here.

Just opened a ticket. Will update here once I hear back from them. Have a wonderful night.

[paaacman]

Has @najens said, we have the same with hellosign-php-sdk.
Apprently HelloSign API does not accept anymore required and editor as null in custom_fields.

It's working if you remove those null fields.

See hellosign/hellosign-php-sdk#119

[adamskinner]

Im getting the same error. Thanks paccman

[justinstanley]

Same error here as well.

[raedbadran]

fixed by removing the nulls. See @paaacman post. Thank you:)

[justinhorner]

fixed by removing the nulls. See @paaacman post. Thank you:)

How are you removing the nulls? Are you sending the data as JSON or as the c# TemplateSignatureRequest class?

[justinstanley]

Has @najens said, we have the same with hellosign-php-sdk.
Apprently HelloSign API does not accept anymore required and editor as null in custom_fields.

It's working if you remove those null fields.

See hellosign/hellosign-php-sdk#119

I only have one signer and they should not be able to edit the custom field, so that route doesn't work for me. I also tried to set "required: false" below but I still receive the same error.

var client = new Client(_apiKey); var request = new TemplateSignatureRequest(); request.AddTemplate(templateId); request.AllowDecline = false; request.AddSigner("client", email, name, pin: pin); request.AddCustomField("name", name, required:false); request.AddCustomField("title", title, required: false);

HelloSign.BadRequestException: 'custom_fields with a required parameter must specify an editor parameter.'

[paaacman]

In the JSON custom_fields, with the SDK, we have "required":null in fields.
I remove null fields in the JSON content.

[justinstanley]

Update from API support - "Thank you for reaching out and sorry to hear about the trouble. We've identified an issue where our release on 9/21 introduced a new error for custom_fields. We are working on a fix. I will continue to keep you updated."

https://status.hellosign.com/incidents/v511033g104w

[aperlstein]

Should we just add this to editor and required on the CustomField model?

[JsonProperty("editor", NullValueHandling=NullValueHandling.Ignore)]

[BHSPitMonkey]

This was indeed caused by server-side validation changes in yesterday's release; A fix was just deployed at 11:00AM Pacific Time (18:00 UTC). Sincere apologies for the inconvenience this bug has caused, and sincere thanks to everyone who provided reports here and via email (all of which were helpful in finding a resolution).