GEgetmaintainx
Vendors

Create new vendor

Changed on
post/vendors

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required
descriptionstring nullable
extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Qualifications")

emailsstring[]

List of email address

phoneNumbersstring[]

List of phone number

Example request

{
  "name": "Acme Corp",
  "description": "Provider of Acme service",
  "extraFields": {
    "Qualifications": "ISO 000"
  },
  "emails": [
    "vendor@example.com"
  ],
  "phoneNumbers": [
    "415-555-0100"
  ]
}

Response

Successfully created vendor

idinteger required

Global ID of the vendor

Example response

{
  "id": 963
}

Changes

  • 222e6fad7c1fRevision changes
    • breaking

      removed the media type application/octet-stream from the request body

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional query request parameter skipWebhook

    • info

      added the new optional request property