Update Organization

PUT 
/organizations/:organizationId

Update Organization

Request

Path Parameters

organizationId stringrequired

The ID of organization.

application/json

Body

required

companyName stringrequired

The company name of organization.

companyVat string

The company VAT of organization.

customUrl stringrequired

The URL of organization.

companyAddress string

The address of organization.

finance object
Financial information of the organization (optional).
phoneNumber string
email string
address object
city string
country string
line1 string
line2 string
postalCode string
state string

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the organization.
id stringrequired
type stringrequired
awsAccountId stringrequired
awsRegion stringrequired
ownerEmail stringrequired
emailDomain stringrequired
customerId stringrequired
customUrl stringrequired
companyName stringrequired
companyVat stringrequired
companyAddress stringrequired
iotEndpoint stringrequired
timezone stringrequired
statistics objectrequired
subscriptionPlan stringrequired
subscriptionStatus stringrequired
finance objectrequired
email stringrequired
phoneNumber stringrequired
address objectrequired
city stringrequired
country stringrequired
line1 stringrequired
line2 stringrequired
postalCode stringrequired
state stringrequired
updatedAtDateString stringrequired
updatedAt numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "string",
    "awsAccountId": "string",
    "awsRegion": "string",
    "ownerEmail": "string",
    "emailDomain": "string",
    "customerId": "string",
    "customUrl": "string",
    "companyName": "string",
    "companyVat": "string",
    "companyAddress": "string",
    "iotEndpoint": "string",
    "timezone": "string",
    "statistics": {},
    "subscriptionPlan": "string",
    "subscriptionStatus": "string",
    "finance": {
      "email": "string",
      "phoneNumber": "string",
      "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postalCode": "string",
        "state": "string"
      }
    },
    "updatedAtDateString": "string",
    "updatedAt": 0
  }
}

Example

{
  "data": {
    "id": "o-organizationId",
    "type": "MultiTenant",
    "awsAccountId": "965578212345",
    "awsRegion": "ap-northeast-1",
    "ownerEmail": "ownerEmail@infodeck.io",
    "emailDomain": "infodeck.io",
    "customerId": "cus_PniZJxxxxxxxxxxC",
    "customUrl": "infodeck",
    "companyName": "Infodeck",
    "companyVat": "VAT-XXXXX",
    "companyAddress": "Taipei City",
    "iotEndpoint": "a3m4oxxxxxxxxxx-ats.iot.ap-northeast-1.amazonaws.com",
    "timezone": "Asia/Taipei",
    "statistics": {
      "assetType": 2,
      "deck": 3,
      "eventRule": 0,
      "eventSchedule": 0,
      "integrationService": 1,
      "location": 2,
      "team": 0,
      "thing": 0,
      "user": 2,
      "workOrder": 0,
      "workRequest": 0
    },
    "subscriptionPlan": "price_1OyTQxxxxxxxxxxE",
    "subscriptionStatus": "active",
    "finance": {
      "email": "dev+stripetest@infodeck.io",
      "phoneNumber": "+886912345678",
      "address": {
        "city": "Taipei",
        "country": "TW",
        "line1": "6F, No. 287, Section 3, Nanjing East Road",
        "line2": "Songshan District",
        "postalCode": "10595",
        "state": "Taiwan"
      }
    },
    "updatedAtDateString": "2024-01-31T00:00:00.000Z",
    "updatedAt": 1706659200000
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...