Disable Buyer

Disable the Buyer object. Disabled buyers cannot be used in transactions.

PreviousEnable Buyer NextGet Buyer

Last updated 18 days ago

Was this helpful?

post

/v1/accounts/buyers/{id}/disable

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/accounts/buyers/{id}/disable'

200

400

404

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-02-23T06:01:44.696Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-02-23T06:01:44.696Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "activated": {
      "at": "2025-02-23T06:01:44.696Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "unassigned": {
      "at": "2025-02-23T06:01:44.696Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "contact": {
    "name": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "hello@example.com",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "user": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-02-23T06:01:44.696Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-02-23T06:01:44.696Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-02-23T06:01:44.696Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-02-23T06:01:44.696Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-02-23T06:01:44.696Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-02-23T06:01:44.696Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "invitationAcceptedAt": "2025-02-23T06:01:44.696Z"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2025-02-23T06:01:44.696Z",
      "settings": {
        "cultureCode": "text",
        "languageCode": "text"
      },
      "name": "text",
      "currentAccount": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-23T06:01:44.696Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "icon": "text",
        "technicalSupportEmail": "hello@example.com",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": [
          {
            "id": "text",
            "audit": "[Circular Reference]",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "description": "text",
            "account": "[Circular Reference]",
            "logo": "text",
            "isDefault": true,
            "modules": "[Circular Reference]",
            "users": "[Circular Reference]",
            "buyers": "[Circular Reference]"
          }
        ]
      },
      "accounts": [
        {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-23T06:01:44.696Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-23T06:01:44.696Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "type": "Client",
          "status": "Active",
          "serviceLevel": "Express",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "icon": "text",
          "technicalSupportEmail": "hello@example.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [
            {
              "id": "text",
              "audit": "[Circular Reference]",
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "description": "text",
              "account": "[Circular Reference]",
              "logo": "text",
              "isDefault": true,
              "modules": "[Circular Reference]",
              "users": "[Circular Reference]",
              "buyers": "[Circular Reference]"
            }
          ]
        }
      ]
    },
    "type": "text"
  },
  "externalIds": {
    "erpCompanyContact": "text",
    "erpCustomer": "text",
    "accountExternalId": "text"
  },
  "status": "Active",
  "icon": "text",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "taxId": "text",
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-02-23T06:01:44.696Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-02-23T06:01:44.696Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "icon": "text",
    "technicalSupportEmail": "hello@example.com",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "description": "text",
        "account": "[Circular Reference]",
        "logo": "text",
        "isDefault": true,
        "modules": "[Circular Reference]",
        "users": "[Circular Reference]",
        "buyers": "[Circular Reference]"
      }
    ]
  },
  "name": "text",
  "errors": [
    {
      "id": "text",
      "message": "text",
      "parameters": null
    }
  ],
  "sellers": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-02-23T06:01:44.696Z",
          "by": "[Circular Reference]"
        },
        "updated": {
          "at": "2025-02-23T06:01:44.696Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "externalId": "text",
      "status": "Active",
      "icon": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text",
      "currencies": [
        "text"
      ]
    }
  ]
}