Register a buyer

Allows a user to register a buyer, which may result in creating a new buyer (201 Created) or updating an existing buyer (200 OK), depending on identity matching.

If a new buyer is created:

  • Values for name, phone, and email found in the request payload will automatically create a contact and set that contactID as the primaryContactID. The address on this contact will not be populated and must be updated via the appropriate endpoint.
  • Status and substatus are both set to "Active".

If an existing buyer is updated:

  • See "Update a buyer" for additional details on updating.
  • Partial updates are not supported. The user of this API must supply all buyer fields in order to avoid omitted fields being deleted.

Upon success, the details of the created or updated buyer will be returned.

Click Try It! to start a request and see the response here!