Skip to main content
PATCH
/
organization
/
update-organization
/
v1
Update organization settings
curl --request PATCH \
  --url https://api.collectpure.com/organization/update-organization/v1 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "vacationMode": true,
  "payoutMethod": "electronic_check",
  "electronicCheckName": "<string>",
  "electronicCheckEmail": "[email protected]"
}
'
{
  "success": true,
  "data": {
    "vacationMode": true,
    "payoutMethod": "<string>",
    "electronicCheckName": "<string>",
    "electronicCheckEmail": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
vacationMode
boolean

Enable or disable vacation mode. When active, listings and offers are hidden from the marketplace.

​
payoutMethod
enum<string>

Default payout method for the organization

Available options:
electronic_check,
teller_ach
​
electronicCheckName
string

Payee name for electronic check payouts

Maximum string length: 40
​
electronicCheckEmail
string<email>

Payee email for electronic check payouts

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

200 - application/json

Default Response

​
success
boolean
required
​
data
object
required