PATCH
/
v1
/
organizations
/
{id}
Go (SDK)
package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Organizations.Update(ctx, "1dbfc517-0bbf-4301-9ba8-555ca42b9737", components.OrganizationUpdate{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Organization != nil {
        // handle response
    }
}
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "name": "<string>",
  "slug": "<string>",
  "avatar_url": "<string>",
  "email": "<string>",
  "website": "<string>",
  "socials": [
    {
      "platform": "x",
      "url": "<string>"
    }
  ],
  "status": "created",
  "details_submitted_at": "2023-11-07T05:31:56Z",
  "feature_settings": {
    "issue_funding_enabled": false
  },
  "subscription_settings": {
    "allow_multiple_subscriptions": true,
    "allow_customer_updates": true,
    "proration_behavior": "invoice"
  },
  "notification_settings": {
    "new_order": true,
    "new_subscription": true
  }
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
id
string<uuid4>
required

The organization ID.

Examples:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

Body

application/json
​
name
string | null
Minimum length: 3
​
avatar_url
string<uri> | null
Required string length: 1 - 2083
​
email
string<email> | null

Public support email.

​
website
string<uri> | null

Official website of the organization.

Required string length: 1 - 2083
​
socials
OrganizationSocialLink · object[] | null

Links to social profiles.

​
details
object | null

Additional, private, business details Polar needs about active organizations for compliance (KYC).

​
feature_settings
object | null
​
subscription_settings
object | null
​
notification_settings
object | null

Response

Organization updated.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
id
string<uuid4>
required

The organization ID.

Examples:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
name
string
required

Organization name shown in checkout, customer portal, emails etc.

​
slug
string
required

Unique organization slug in checkout, customer portal and credit card statements.

​
avatar_url
string | null
required

Avatar URL shown in checkout, customer portal, emails etc.

​
email
string | null
required

Public support email.

​
website
string | null
required

Official website of the organization.

​
socials
OrganizationSocialLink · object[]
required

Links to social profiles.

​
status
enum<string>
required

Current organization status

Available options:
created,
onboarding_started,
under_review,
denied,
active
​
details_submitted_at
string<date-time> | null
required

When the business details were submitted.

​
feature_settings
object | null
required

Organization feature settings

​
subscription_settings
object
required

Settings related to subscriptions management

​
notification_settings
object
required

Settings related to notifications