DataFlex / DocuSign REST API / Creates one or more brand profile files for the account.
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "brandCompany": "sample string 1",
// "brandId": "sample string 2",
// "brandName": "sample string 3",
// "colors": [
// {}
// ],
// "isOverridingCompanyName": "sample string 4",
// "isSendingDefault": "sample string 5",
// "isSigningDefault": "sample string 6",
// "landingPages": [
// {}
// ],
// "links": [
// {
// "linkType": "sample string 1",
// "urlOrMailTo": "sample string 2",
// "linkText": "sample string 3",
// "showLink": "sample string 4"
// }
// ],
// "emailContent": [
// {
// "emailContentType": "sample string 1",
// "content": "sample string 2",
// "emailToLink": "sample string 3",
// "linkText": "sample string 4"
// }
// ],
// "logos": {
// "primary": "sample string 1",
// "secondary": "sample string 2",
// "email": "sample string 3"
// },
// "resources": {
// "email": "sample string 1",
// "sending": "sample string 2",
// "signing": "sample string 3",
// "signingCaptive": "sample string 4"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "brandCompany" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "brandId" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "brandName" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "isOverridingCompanyName" "sample string 4" To iSuccess
Get ComUpdateString Of hoJson "isSendingDefault" "sample string 5" To iSuccess
Get ComUpdateString Of hoJson "isSigningDefault" "sample string 6" To iSuccess
Get ComUpdateString Of hoJson "links[0].linkType" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "links[0].urlOrMailTo" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "links[0].linkText" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "links[0].showLink" "sample string 4" To iSuccess
Get ComUpdateString Of hoJson "emailContent[0].emailContentType" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "emailContent[0].content" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "emailContent[0].emailToLink" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "emailContent[0].linkText" "sample string 4" To iSuccess
Get ComUpdateString Of hoJson "logos.primary" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "logos.secondary" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "logos.email" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "resources.email" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "resources.sending" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "resources.signing" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "resources.signingCaptive" "sample string 4" To iSuccess
// Adds the "Authorization: Bearer {{accessToken}}" header.
Set ComAuthToken Of hoHttp To "{{accessToken}}"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/v2.1/accounts/{{accountId}}/brands" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"brandCompany": "sample string 1",
"brandId": "sample string 2",
"brandName": "sample string 3",
"colors": [
{}
],
"isOverridingCompanyName": "sample string 4",
"isSendingDefault": "sample string 5",
"isSigningDefault": "sample string 6",
"landingPages": [
{}
],
"links": [
{
"linkType": "sample string 1",
"urlOrMailTo": "sample string 2",
"linkText": "sample string 3",
"showLink": "sample string 4"
}
],
"emailContent": [
{
"emailContentType": "sample string 1",
"content": "sample string 2",
"emailToLink": "sample string 3",
"linkText": "sample string 4"
}
],
"logos": {
"primary": "sample string 1",
"secondary": "sample string 2",
"email": "sample string 3"
},
"resources": {
"email": "sample string 1",
"sending": "sample string 2",
"signing": "sample string 3",
"signingCaptive": "sample string 4"
}
}'
https://domain.com/v2.1/accounts/{{accountId}}/brands
Postman Collection Item JSON
{
"name": "Creates one or more brand profile files for the account.",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"brandCompany\": \"sample string 1\",\n \"brandId\": \"sample string 2\",\n \"brandName\": \"sample string 3\",\n \"colors\": [\n {}\n ],\n \"isOverridingCompanyName\": \"sample string 4\",\n \"isSendingDefault\": \"sample string 5\",\n \"isSigningDefault\": \"sample string 6\",\n \"landingPages\": [\n {}\n ],\n \"links\": [\n {\n \"linkType\": \"sample string 1\",\n \"urlOrMailTo\": \"sample string 2\",\n \"linkText\": \"sample string 3\",\n \"showLink\": \"sample string 4\"\n }\n ],\n \"emailContent\": [\n {\n \"emailContentType\": \"sample string 1\",\n \"content\": \"sample string 2\",\n \"emailToLink\": \"sample string 3\",\n \"linkText\": \"sample string 4\"\n }\n ],\n \"logos\": {\n \"primary\": \"sample string 1\",\n \"secondary\": \"sample string 2\",\n \"email\": \"sample string 3\"\n },\n \"resources\": {\n \"email\": \"sample string 1\",\n \"sending\": \"sample string 2\",\n \"signing\": \"sample string 3\",\n \"signingCaptive\": \"sample string 4\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/brands",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"brands"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
},
"description": "Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call.\n\nAn error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version.\n\nWhen brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`."
},
"response": [
]
}
