How to send tags with the sending request?

  • 1
  • Question
  • Updated 3 months ago

I'm integrating to your V4 API from V3.

On this page: https://api.rightsignature.com/documentation/resources/v1/sending_requests.en.html it mentions we can include document tags as a key value pair. The documentation isn't clear on how to add the tags as in what format is should be in. Are you able to send me an example of the document tags for this call? 

I've uploaded an array of strings but got an error saying invalid format for text tags.
Photo of David

David

  • 5 Posts
  • 0 Reply Likes
  • unsure

Posted 3 months ago

  • 1
Photo of Saravanan Kannan

Saravanan Kannan, Employee

  • 37 Posts
  • 6 Reply Likes
Hi David,

Your json should look like this, if you want to include tags on your document:


{
"file": {
"name": "testSR.pdf",
"source": "upload"
},
"document": {
"signer_sequencing": false,
"expires_in": 12,
"name": "Sign me",
"tags": {
"tag_1": "value_1",
"tag_2": "value_2"
},
"roles": [{
"name": "a",
"signer_name": "John",
"signer_email": "john@doe.com"
}]
},
"sending_request": {}
}

Thanks
Saravanan
Photo of David

David

  • 5 Posts
  • 0 Reply Likes
I actually have the error now:

"Invalid parameter 'tags' Must be a hash with non empty keys"
Photo of David

David

  • 5 Posts
  • 0 Reply Likes
I made another call with the json format you provided and it worked. Thank you.