STstellar
Organization

Update Organization Profile

Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.

patch/organization

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Request body multipart/form-data

logostring binary

The logo of the organization, file type must be png or jpeg.

datastring json

A JSON string that contains the details to update. Every key is optional; only the keys you send are changed.

  • organization_name (string): the new name of the organization, up to 64 characters.
  • timezone_utc_offset (string): the new timezone offset of the organization.
  • is_approval_required (boolean): whether the approval workflow is enabled or not.
  • is_link_shortener_enabled (boolean): whether registration links sent to receivers are shortened.
  • is_memo_tracing_enabled (boolean): whether payments carry a tracing memo.
  • receiver_registration_message_template (string): the message template sent to the receivers inviting them to registration. Up to 255 characters, and it cannot contain HTML, JS or CSS. Sending this field empty sets the default value for it.
  • otp_message_template (string): the message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the default value for it.
  • privacy_policy_link (string): a URL to the organization privacy policy. Sending it empty clears it.
  • webhook_url (string): an https URL the SDP delivers outbox events to. Owner only; sending it empty clears it.
  • receiver_invitation_resend_interval_days (number): how often an unregistered receiver is re-invited. Sending 0 clears it.
  • payment_cancellation_period_days (number): how long a READY payment waits before it is canceled automatically. Sending 0 clears it.
  • mfa_disabled (boolean): whether multi-factor authentication is turned off for dashboard sign-in.
  • captcha_disabled (boolean): whether reCAPTCHA is turned off.
  • receiver_invitations_disabled (boolean): whether receiver invitation messages are suppressed.
  • reporting_enabled (boolean): whether the Reports feature (/reports/*) is on for the organization. Defaults to false.

For example:

{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_required": true, "receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.", "otp_message_template": "{{.OTP}} is your {{.OrganizationName}} phone verification code."}

Response

OK

messagestring required

Changes

No recorded changes to this operation across all 13 revisions of this API.