Update an organization by ID

PUT /organizations/{organizationId}

Try it

Update an organization by ID

cURL

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "An example name",
  "description": "An example name",
  "websiteUrl": "https://website-sample.com"
}
'

200

{
  "organization": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "name": "Acme Corp",
    "description": "An example name",
    "websiteUrl": "https://website-sample.com",
    "address": {
      "addressLine1": "An example name",
      "addressLine2": "An example name",
      "city": "An example name",
      "region": "An example name",
      "postalCode": "An example name",
      "country": "US"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId · string · required

ID of organization

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

User new fields data

name · string · required

Maximum string length: 255

Example:

"An example name"

description · string

Maximum string length: 255

Example:

"An example name"

websiteUrl · string

Maximum string length: 255

Example:

"https://website-sample.com"

Response

200

application/json

successful operation - organization fields updated

organization · object

Show child attributes

organization. id · string · required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

organization. name · string · required

Example:

"Acme Corp"

organization. description · string

Example:

"An example name"

organization. websiteUrl · string

Example:

"https://website-sample.com"

organization. address · object

Show child attributes

organization.address. addressLine1 · string

Maximum string length: 255

Example:

"An example name"

organization.address. addressLine2 · string

Maximum string length: 255

Example:

"An example name"

organization.address. city · string

Maximum string length: 50

Example:

"An example name"

organization.address. region · string

Maximum string length: 50

Example:

"An example name"

organization.address. postalCode · string

Maximum string length: 50

Example:

"An example name"

organization.address. country · string

ISO 3166-1 alpha-2 country code

Maximum string length: 2

Example:

"US"