Update Account

Update the Account object.

put
Path parameters
idstringRequired
Body
logostring · binaryOptional
Responses
200
OK
application/json
put
PUT /public/v1/accounts/accounts/{id} HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 3262

{
  "account": {
    "ExternalIds.PyraTenantId": "123e4567-e89b-12d3-a456-426614174000",
    "ExternalId": "text",
    "ExternalName": "text",
    "Type": "Client",
    "Status": "Active",
    "ServiceLevel": "Express",
    "Address.AddressLine1": "text",
    "Address.AddressLine2": "text",
    "Address.PostCode": "text",
    "Address.City": "text",
    "Address.State": "text",
    "Address.Country": "text",
    "TechnicalSupportEmail": "text",
    "Website": "text",
    "Description": "text",
    "Name": "text",
    "Groups": [
      {
        "id": "text",
        "audit": {
          "created": "[Circular Reference]",
          "updated": "[Circular Reference]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "description": "text",
        "account": {
          "id": "text",
          "icon": "text",
          "type": "text",
          "status": "text",
          "name": "text"
        },
        "modules": [
          {
            "id": "text",
            "description": "text",
            "name": "text",
            "filters": {
              "group.buyers": [
                "text"
              ]
            },
            "settings": {
              "configurable": true,
              "default": true,
              "paid": true,
              "type": [
                "text"
              ],
              "obsolete": true,
              "eligibility": {
                "multi": true,
                "single": true
              }
            }
          }
        ],
        "logo": "text",
        "isDefault": true,
        "users": [
          {
            "id": "text",
            "icon": "text",
            "name": "text"
          }
        ],
        "buyers": [
          {
            "id": "text",
            "icon": "text",
            "name": "text"
          }
        ]
      }
    ],
    "Eligibility.Client": true,
    "Eligibility.Partner": true,
    "Icon": "text",
    "IconFileId": "text",
    "Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Created.At": "2025-06-22T04:48:55.320Z",
    "Audit.Created.ById": "text",
    "Audit.Created.By.Name": "text",
    "Audit.Created.By.Icon": "text",
    "Audit.Created.By.HasIcon": true,
    "Audit.Created.By.Type": "User",
    "Audit.Created.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Created.By.Audit.Created": {
      "at": "2025-06-22T04:48:55.320Z",
      "by": {
        "id": "text",
        "audit": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text"
      }
    },
    "Audit.Created.By.Audit.Updated.At": "2025-06-22T04:48:55.320Z",
    "Audit.Created.By.Audit.Updated.ById": "text",
    "Audit.Created.By.Audit.Updated.By": {
      "id": "text",
      "audit": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text"
    },
    "Audit.Created.By.Id": "text",
    "Audit.Created.By.SystemId": 1,
    "Audit.Updated.At": "2025-06-22T04:48:55.320Z",
    "Audit.Updated.ById": "text",
    "Audit.Updated.By.Name": "text",
    "Audit.Updated.By.Icon": "text",
    "Audit.Updated.By.HasIcon": true,
    "Audit.Updated.By.Type": "User",
    "Audit.Updated.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Updated.By.Audit.Created.At": "2025-06-22T04:48:55.320Z",
    "Audit.Updated.By.Audit.Created.ById": "text",
    "Audit.Updated.By.Audit.Created.By": {
      "id": "text",
      "audit": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text"
    },
    "Audit.Updated.By.Audit.Updated": {
      "at": "2025-06-22T04:48:55.320Z",
      "by": {
        "id": "text",
        "audit": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text"
      }
    },
    "Audit.Updated.By.Id": "text",
    "Audit.Updated.By.SystemId": 1,
    "Id": "text",
    "SystemId": 1
  },
  "logo": "binary"
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-22T04:48:55.320Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-22T04:48:55.320Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "icon": "text",
  "externalIds": {
    "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "externalId": "text",
  "externalName": "text",
  "type": "text",
  "status": "text",
  "serviceLevel": "text",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "technicalSupportEmail": "[email protected]",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "eligibility": {
    "client": true,
    "partner": true
  }
}

Last updated

Was this helpful?