Update Organization Settings

Request

Path Params

id

string

required

Body Params application/json

branding

object (OrganizationBranding)

optional

Custom branding configuration for organization.

colors

object

optional

logoUrl

string

optional

Media URL for organization's logo

logoWidth

integer

optional

Width in pixel of organization's logo

defaultStorageProvider

enum<string>

optional

Default cloud storage provider where all uploaded data will be stored.

Allowed values:

GOOGLE_DRIVEPIGEON

sharedDashboard

boolean

optional

sharedContacts

boolean

optional

convertImagesToPdf

boolean

optional

dueDateGracePeriod

integer

optional

defaultVDSPeriod

integer

optional

maxVDSPeriod

integer

optional

defaultSendMethod

enum<string>

optional

Allowed values:

DEFAULTEMAILSMSBOTHMULTIPLE

defaultAuthMethod

object (AuthenticationMethod)

optional

type

enum<string>

required

Authentication method

Allowed values:

EMAIL_ACCESS_CODESMS_ACCESS_CODESECURITY_QUESTION

questionText

string

optional

Security question text. Required if type set to SECURITY_QUESTION

questionAnswer

string

optional

Correct, expected answer to the security question. Required if type set to SECURITY_QUESTION

disallowedFileExtensions

array[string]

optional

displayPostSignatureConfirmation

boolean

optional

Indicates whether or not a user should be navigated to a confirmation page after completing an e-signing request. Defaults to false.

outgoingEmailAddress

string <email>

optional

Email address to use for all outgoing Pigeon transactional emails ("From" email)

Example

{
  "branding": {
    "colors": {
      "primary": "string"
    },
    "logoUrl": "string",
    "logoWidth": 0
  },
  "defaultStorageProvider": "GOOGLE_DRIVE",
  "sharedDashboard": true,
  "sharedContacts": true,
  "convertImagesToPdf": true,
  "dueDateGracePeriod": 0,
  "defaultVDSPeriod": 0,
  "maxVDSPeriod": 0,
  "defaultSendMethod": "DEFAULT",
  "defaultAuthMethod": {
    "type": "EMAIL_ACCESS_CODE",
    "questionText": "string",
    "questionAnswer": "string"
  },
  "disallowedFileExtensions": [
    "string"
  ],
  "displayPostSignatureConfirmation": true,
  "outgoingEmailAddress": "user@example.com"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH '/organizations//settings' \
--header 'Content-Type: application/json' \
--data-raw '{
    "branding": {
        "colors": {
            "primary": "string"
        },
        "logoUrl": "string",
        "logoWidth": 0
    },
    "defaultStorageProvider": "GOOGLE_DRIVE",
    "sharedDashboard": true,
    "sharedContacts": true,
    "convertImagesToPdf": true,
    "dueDateGracePeriod": 0,
    "defaultVDSPeriod": 0,
    "maxVDSPeriod": 0,
    "defaultSendMethod": "DEFAULT",
    "defaultAuthMethod": {
        "type": "EMAIL_ACCESS_CODE",
        "questionText": "string",
        "questionAnswer": "string"
    },
    "disallowedFileExtensions": [
        "string"
    ],
    "displayPostSignatureConfirmation": true,
    "outgoingEmailAddress": "user@example.com"
}'

Responses

🟢200Success

application/json

Body

id

string

required

Organization ID

branding

object (OrganizationBranding)

optional

Custom branding configuration for organization.

colors

object

optional

logoUrl

string

optional

Media URL for organization's logo

logoWidth

integer

optional

Width in pixel of organization's logo

defaultStorageProvider

enum<string>

optional

Default cloud storage provider where all uploaded data will be stored.

Allowed values:

GOOGLE_DRIVEPIGEON

sharedDashboard

boolean

optional

sharedContacts

boolean

optional

convertImagesToPdf

boolean

optional

dueDateGracePeriod

integer

optional

defaultVDSPeriod

integer

optional

maxVDSPeriod

integer

optional

defaultSendMethod

enum<string>

optional

Allowed values:

DEFAULTEMAILSMSBOTHMULTIPLE

defaultAuthMethod

object (AuthenticationMethod)

optional

type

enum<string>

required

Authentication method

Allowed values:

EMAIL_ACCESS_CODESMS_ACCESS_CODESECURITY_QUESTION

questionText

string

optional

Security question text. Required if type set to SECURITY_QUESTION

questionAnswer

string

optional

Correct, expected answer to the security question. Required if type set to SECURITY_QUESTION

disallowedFileExtensions

array[string]

optional

displaySignatureConfirmationPage

boolean

optional

Indicates whether or not a confirmation page should be appended to e-signature sessions. Defaults to false.

sendEmailsFromUserAddress

boolean

optional

Indicates wheteher Pigeon transactional emails are sent from the user creating a request. When false, emails are sent from no-reply@pigeondocuments.com. Defaults to false.

Default:

false

Example

{
  "id": "nostrud sint eiusmod esse",
  "branding": {
    "colors": {
      "primary": "#00000",
      "secondary": "#ffffff"
    },
    "logoUrl": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgYmFzZVByb2ZpbGU9ImZ1bGwiIHdpZHRoPSIxMTIzIiBoZWlnaHQ9IjMxMzEiPjxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9IiNjMDFhOTMiLz48dGV4dCB4PSI1NjEuNSIgeT0iMTU2NS41IiBmb250LXNpemU9IjIwIiBhbGlnbm1lbnQtYmFzZWxpbmU9Im1pZGRsZSIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZmlsbD0id2hpdGUiPjExMjN4MzEzMTwvdGV4dD48L3N2Zz4="
  },
  "defaultStorageProvider": "GOOGLE_DRIVE",
  "sharedDashboard": true,
  "sharedContacts": true,
  "convertImagesToPdf": true,
  "dueDateGracePeriod": -91150445,
  "defaultVDSPeriod": -47495232,
  "maxVDSPeriod": 48460292,
  "defaultSendMethod": "SMS",
  "defaultAuthMethod": {
    "type": "SECURITY_QUESTION",
    "questionText": "aliqua",
    "questionAnswer": "eu nulla deserunt"
  },
  "disallowedFileExtensions": [
    "et occaecat"
  ],
  "displayPostSignatureConfirmation": false
}

🟠400Bad Request

🟠404Record Not Found