Vendor custom fields

Remove a vendor custom field value

Clears one custom field value on a vendor. The field definition is untouched and stays on the vendor's list with no value; only the stored value goes.

DELETE

https://api.portal.magicdoor.com/company-app/vendors/{vendorId}/custom-fields/{customFieldId}

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

vendorIdstringrequired

The vendor whose custom fields you are working with. A Snowflake id, sent as a decimal string.

example: 1830472847398404100

customFieldIdstringrequired

The custom field definition. A Snowflake id, sent as a decimal string.

example: 1830472847398404200

Response

200 · The value was cleared, or there was none to clear. The response has no body.

401 · The access token is missing, expired, or does not belong to a property manager.

404 · No custom field with that id exists for the calling company. A record that belongs to another company is reported the same way as one that does not exist. The id you asked for is in `entityId`; `detail` names only the kind of record.

Request

curl --request DELETE \
  --url 'https://api.portal.magicdoor.com/company-app/vendors/1830472847398404100/custom-fields/1830472847398404200' \
  --header 'Authorization: Bearer <token>'

Response

{
  "type": "https://httpstatuses.com/404",
  "title": "Not Found",
  "status": 404,
  "detail": "CustomField not found.",
  "instance": "/company-app/vendors/1830472847398404100/custom-fields/1830472847398404200",
  "traceId": "0HN7GK9C2M4PQ",
  "entityType": "CustomField",
  "entityId": "1830472847398404200"
}