Update Organization Profile

PATCH 
/organization

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.

Request

multipart/form-data

Body

logo binary

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

data json

A JSON string that contains the details to update. Contains the following keys: organization_name (string): the new name of the organization, timezone_utc_offset (string): the new timezone offset of the organization, is_approval_required (boolean): whether the approval workflow is enabled or not. sms_registration_message_template (string): the SMS message template sent to the receivers inviting them to registration. Sending this field empty sets the default value for it. otp_message_template (string): the SMS message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the default value for it. For example: '{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_required": true, "sms_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."}'

Responses

200

OK

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "organization profile updated successfully"
}

401

Unauthorized

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

Loading...