Organization

Create a new organization

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

idintegerOptional

namestringRequired

apiKeystringOptional

accessCodestringOptional

urlCodestringOptional

logoIdstringOptional

descriptionstringOptional

attributesstringOptional

parentOrganizationIdintegerOptional

parentOrganizationUrlCodestringOptional

Responses

200Success

application/json

post

/api/organization

HTTPcURLJavaScriptPython

POST /api/organization HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "id": 1,
  "name": "text",
  "apiKey": "text",
  "accessCode": "text",
  "urlCode": "text",
  "logoId": "text",
  "description": "text",
  "attributes": "text",
  "parentOrganizationId": 1,
  "parentOrganizationUrlCode": "text",
  "addresses": [
    {
      "id": 1,
      "title": "text",
      "line1": "text",
      "line2": "text",
      "state": "text",
      "country": "text",
      "zipCode": "text",
      "delete": true,
      "city": "text",
      "district": "text",
      "latitude": 1,
      "longitude": 1,
      "addressType": "PRIMARY",
      "organizationId": 1,
      "deleted": true,
      "personId": 1
    }
  ]
}

200Success

{
  "id": 12,
  "name": "Azodha",
  "urlCode": "dev-azodha",
  "apiKey": "1v23-v456-a987",
  "accessCode": "asfdg23",
  "addresses": [],
  "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
  "logoUrl": null,
  "description": "This is a test organization",
  "attributes": {},
  "parentOrganizationId": 23,
  "parentOrganization": {
    "id": 12,
    "name": "Azodha",
    "urlCode": "dev-azodha",
    "apiKey": "1v23-v456-a987",
    "accessCode": "asfdg23",
    "addresses": [],
    "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
    "logoUrl": null,
    "description": "This is a test organization",
    "attributes": {},
    "parentOrganizationId": 23,
    "parentOrganization": {
      "id": 12,
      "name": "Azodha",
      "urlCode": "dev-azodha",
      "apiKey": "1v23-v456-a987",
      "accessCode": "asfdg23",
      "addresses": [],
      "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
      "logoUrl": null,
      "description": "This is a test organization",
      "attributes": {},
      "parentOrganizationId": 23,
      "parentOrganization": {
        "id": 12,
        "name": "Azodha",
        "urlCode": "dev-azodha",
        "apiKey": "1v23-v456-a987",
        "accessCode": "asfdg23",
        "addresses": [],
        "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
        "logoUrl": null,
        "description": "This is a test organization",
        "attributes": {},
        "parentOrganizationId": 23,
        "parentOrganization": {
          "id": 12,
          "name": "Azodha",
          "urlCode": "dev-azodha",
          "apiKey": "1v23-v456-a987",
          "accessCode": "asfdg23",
          "addresses": [],
          "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
          "logoUrl": null,
          "description": "This is a test organization",
          "attributes": {},
          "parentOrganizationId": 23,
          "parentOrganization": {
            "id": 12,
            "name": "Azodha",
            "urlCode": "dev-azodha",
            "apiKey": "1v23-v456-a987",
            "accessCode": "asfdg23",
            "addresses": [],
            "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
            "logoUrl": null,
            "description": "This is a test organization",
            "attributes": {},
            "parentOrganizationId": 23,
            "parentOrganization": "[Circular Reference]",
            "childOrganizations": "[Circular Reference]",
            "organizationSettings": [],
            "language": "[Circular Reference]",
            "ehrIntegrations": "[Circular Reference]",
            "webhookConfiguration": [],
            "attributeSchema": [],
            "emailTemplate": [],
            "organizationResourceIntegration": "[Circular Reference]",
            "surveys": "[Circular Reference]",
            "observationGroup": "[Circular Reference]",
            "healthRecordAttribute": [],
            "wearablesApiSync": "[Circular Reference]",
            "aiInferenceUseCases": "[Circular Reference]",
            "workflow": [],
            "organizationModuleMapping": []
          },
          "childOrganizations": [],
          "organizationSettings": [],
          "language": [],
          "ehrIntegrations": [],
          "webhookConfiguration": [],
          "attributeSchema": [],
          "emailTemplate": [],
          "organizationResourceIntegration": [],
          "surveys": [],
          "observationGroup": [],
          "healthRecordAttribute": [],
          "wearablesApiSync": [],
          "aiInferenceUseCases": [],
          "workflow": [],
          "organizationModuleMapping": []
        },
        "childOrganizations": [],
        "organizationSettings": [],
        "language": [],
        "ehrIntegrations": [],
        "webhookConfiguration": [],
        "attributeSchema": [],
        "emailTemplate": [],
        "organizationResourceIntegration": [],
        "surveys": [],
        "observationGroup": [],
        "healthRecordAttribute": [],
        "wearablesApiSync": [],
        "aiInferenceUseCases": [],
        "workflow": [],
        "organizationModuleMapping": []
      },
      "childOrganizations": [],
      "organizationSettings": [],
      "language": [],
      "ehrIntegrations": [],
      "webhookConfiguration": [],
      "attributeSchema": [],
      "emailTemplate": [],
      "organizationResourceIntegration": [],
      "surveys": [],
      "observationGroup": [],
      "healthRecordAttribute": [],
      "wearablesApiSync": [],
      "aiInferenceUseCases": [],
      "workflow": [],
      "organizationModuleMapping": []
    },
    "childOrganizations": [],
    "organizationSettings": [],
    "language": [],
    "ehrIntegrations": [],
    "webhookConfiguration": [],
    "attributeSchema": [],
    "emailTemplate": [],
    "organizationResourceIntegration": [],
    "surveys": [],
    "observationGroup": [],
    "healthRecordAttribute": [],
    "wearablesApiSync": [],
    "aiInferenceUseCases": [],
    "workflow": [],
    "organizationModuleMapping": []
  },
  "childOrganizations": [],
  "organizationSettings": [],
  "language": [],
  "ehrIntegrations": [],
  "webhookConfiguration": [],
  "attributeSchema": [],
  "emailTemplate": [],
  "organizationResourceIntegration": [],
  "surveys": [],
  "observationGroup": [],
  "healthRecordAttribute": [],
  "wearablesApiSync": [],
  "aiInferenceUseCases": [],
  "workflow": [],
  "organizationModuleMapping": []
}

Update an existing organization

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Body

application/json

idintegerOptional

namestringRequired

apiKeystringOptional

accessCodestringOptional

urlCodestringOptional

logoIdstringOptional

descriptionstringOptional

attributesstringOptional

parentOrganizationIdintegerOptional

parentOrganizationUrlCodestringOptional

Responses

200Success

application/json

put

/api/organization/{id}

HTTPcURLJavaScriptPython

PUT /api/organization/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "id": 1,
  "name": "text",
  "apiKey": "text",
  "accessCode": "text",
  "urlCode": "text",
  "logoId": "text",
  "description": "text",
  "attributes": "text",
  "parentOrganizationId": 1,
  "parentOrganizationUrlCode": "text",
  "addresses": [
    {
      "id": 1,
      "title": "text",
      "line1": "text",
      "line2": "text",
      "state": "text",
      "country": "text",
      "zipCode": "text",
      "delete": true,
      "city": "text",
      "district": "text",
      "latitude": 1,
      "longitude": 1,
      "addressType": "PRIMARY",
      "organizationId": 1,
      "deleted": true,
      "personId": 1
    }
  ]
}

200Success

{
  "id": 12,
  "name": "Azodha",
  "urlCode": "dev-azodha",
  "apiKey": "1v23-v456-a987",
  "accessCode": "asfdg23",
  "addresses": [],
  "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
  "logoUrl": null,
  "description": "This is a test organization",
  "attributes": {},
  "parentOrganizationId": 23,
  "parentOrganization": {
    "id": 12,
    "name": "Azodha",
    "urlCode": "dev-azodha",
    "apiKey": "1v23-v456-a987",
    "accessCode": "asfdg23",
    "addresses": [],
    "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
    "logoUrl": null,
    "description": "This is a test organization",
    "attributes": {},
    "parentOrganizationId": 23,
    "parentOrganization": {
      "id": 12,
      "name": "Azodha",
      "urlCode": "dev-azodha",
      "apiKey": "1v23-v456-a987",
      "accessCode": "asfdg23",
      "addresses": [],
      "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
      "logoUrl": null,
      "description": "This is a test organization",
      "attributes": {},
      "parentOrganizationId": 23,
      "parentOrganization": {
        "id": 12,
        "name": "Azodha",
        "urlCode": "dev-azodha",
        "apiKey": "1v23-v456-a987",
        "accessCode": "asfdg23",
        "addresses": [],
        "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
        "logoUrl": null,
        "description": "This is a test organization",
        "attributes": {},
        "parentOrganizationId": 23,
        "parentOrganization": {
          "id": 12,
          "name": "Azodha",
          "urlCode": "dev-azodha",
          "apiKey": "1v23-v456-a987",
          "accessCode": "asfdg23",
          "addresses": [],
          "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
          "logoUrl": null,
          "description": "This is a test organization",
          "attributes": {},
          "parentOrganizationId": 23,
          "parentOrganization": {
            "id": 12,
            "name": "Azodha",
            "urlCode": "dev-azodha",
            "apiKey": "1v23-v456-a987",
            "accessCode": "asfdg23",
            "addresses": [],
            "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
            "logoUrl": null,
            "description": "This is a test organization",
            "attributes": {},
            "parentOrganizationId": 23,
            "parentOrganization": "[Circular Reference]",
            "childOrganizations": "[Circular Reference]",
            "organizationSettings": [],
            "language": "[Circular Reference]",
            "ehrIntegrations": "[Circular Reference]",
            "webhookConfiguration": [],
            "attributeSchema": [],
            "emailTemplate": [],
            "organizationResourceIntegration": "[Circular Reference]",
            "surveys": "[Circular Reference]",
            "observationGroup": "[Circular Reference]",
            "healthRecordAttribute": [],
            "wearablesApiSync": "[Circular Reference]",
            "aiInferenceUseCases": "[Circular Reference]",
            "workflow": [],
            "organizationModuleMapping": []
          },
          "childOrganizations": [],
          "organizationSettings": [],
          "language": [],
          "ehrIntegrations": [],
          "webhookConfiguration": [],
          "attributeSchema": [],
          "emailTemplate": [],
          "organizationResourceIntegration": [],
          "surveys": [],
          "observationGroup": [],
          "healthRecordAttribute": [],
          "wearablesApiSync": [],
          "aiInferenceUseCases": [],
          "workflow": [],
          "organizationModuleMapping": []
        },
        "childOrganizations": [],
        "organizationSettings": [],
        "language": [],
        "ehrIntegrations": [],
        "webhookConfiguration": [],
        "attributeSchema": [],
        "emailTemplate": [],
        "organizationResourceIntegration": [],
        "surveys": [],
        "observationGroup": [],
        "healthRecordAttribute": [],
        "wearablesApiSync": [],
        "aiInferenceUseCases": [],
        "workflow": [],
        "organizationModuleMapping": []
      },
      "childOrganizations": [],
      "organizationSettings": [],
      "language": [],
      "ehrIntegrations": [],
      "webhookConfiguration": [],
      "attributeSchema": [],
      "emailTemplate": [],
      "organizationResourceIntegration": [],
      "surveys": [],
      "observationGroup": [],
      "healthRecordAttribute": [],
      "wearablesApiSync": [],
      "aiInferenceUseCases": [],
      "workflow": [],
      "organizationModuleMapping": []
    },
    "childOrganizations": [],
    "organizationSettings": [],
    "language": [],
    "ehrIntegrations": [],
    "webhookConfiguration": [],
    "attributeSchema": [],
    "emailTemplate": [],
    "organizationResourceIntegration": [],
    "surveys": [],
    "observationGroup": [],
    "healthRecordAttribute": [],
    "wearablesApiSync": [],
    "aiInferenceUseCases": [],
    "workflow": [],
    "organizationModuleMapping": []
  },
  "childOrganizations": [],
  "organizationSettings": [],
  "language": [],
  "ehrIntegrations": [],
  "webhookConfiguration": [],
  "attributeSchema": [],
  "emailTemplate": [],
  "organizationResourceIntegration": [],
  "surveys": [],
  "observationGroup": [],
  "healthRecordAttribute": [],
  "wearablesApiSync": [],
  "aiInferenceUseCases": [],
  "workflow": [],
  "organizationModuleMapping": []
}