Update identity
post/v1/senderIdentities/updateUpdates the name of the existing sender identity. Should provide the email address of the sender identity for this.
Code snippet
curl -X 'POST' \ 'https://api.boldsign.com/v1/senderIdentities/update?email=luthercooper%40cubeflakes.com' \ -H 'accept: */*' \ -H 'X-API-KEY: {your API key}' \ -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \ -d '{ "name": "Luther", "redirectUrl": "https://boldsign.com", "notificationSettings": { "viewed": true, "sent": false, "deliveryFailed": true, "declined": true, "revoked": true, "reassigned": true, "completed": true, "signed": true, "expired": true, "authenticationFailed": true, "reminders": true } }'
var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}"); var senderIdentityClient = new SenderIdentityClient(apiClient); NotificationSettings notificationSettings = new NotificationSettings(); notificationSettings.Viewed = true; notificationSettings.Sent = false; notificationSettings.DeliveryFailed = true; notificationSettings.Declined = true; notificationSettings.Revoked = true; notificationSettings.Reassigned = true; notificationSettings.Completed = true; notificationSettings.Signed = true; notificationSettings.Expired = true; notificationSettings.AuthenticationFailed = true; notificationSettings.Reminders = true; var senderIdentityRequest = new SenderIdentityRequest("Luther", "luthercooper@cubeflakes.com", notificationSettings, redirectUrl: "https://boldsign.com"); senderIdentityClient.UpdateSenderIdentity(senderIdentityRequest);
import requests url = "https://api.boldsign.com/v1/senderIdentities/update?email=luthercooper%40cubeflakes.com" payload = "{ \"name\": \"Luther\", \"notificationSettings\": { \"viewed\": true, \"sent\": false, \"deliveryFailed\": true, \"declined\": true, \"revoked\": true, \"reassigned\": true, \"completed\": true, \"signed\": true, \"expired\": true, \"authenticationFailed\": true, \"reminders\": true, \"redirectUrl\": \"https://boldsign.com\" }}" headers = { 'accept': '*/*', 'X-API-KEY': '{your API key}', 'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text)
const axios = require('axios'); const response = await axios.post( 'https://api.boldsign.com/v1/senderIdentities/update', { name: 'Luther', redirectUrl: 'https://boldsign.com', notificationSettings: { viewed: true, sent: false, deliveryFailed: true, declined: true, revoked: true, reassigned: true, completed: true, signed: true, expired: true, authenticationFailed: true, reminders: true, }, }, { params: { email: 'luthercooper@cubeflakes.com', }, headers: { accept: '*/*', 'X-API-KEY': '{your API key}', 'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true', }, } );
Query parameters
emailStringRequired | Email address of the sender identity. |
Request body
nameString | Name of the sender identity. Either name or redirectUrl is required to update. | ||||||||||||||||||||||
redirectUrlstring | You can set this property to redirect to a specific URL once the user has either approved or rejected. Either name or redirectUrl is required to update. | ||||||||||||||||||||||
notificationSettingsobject | Notification Settings of the sender identity.
|
Example response
204 No content