Add a contact to a vendor

POST/v1/api/store/{team_slug}/vendor/{hash_id}/contact

v1Operation ID v1_public_vendor_contact_store

Adds a contact to the vendor and returns it. It becomes primary only when the vendor has no other live contact; is_primary is required but not used.

Permission

Needs the Manage Vendors permission at the level that can update vendors.

Business rules

• Warning: YoPrint does not verify that the vendor ID exists. The contact is saved under the vendor ID from the path even when that vendor is deleted or does not exist. Check the vendor ID before adding a contact.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The vendor's id (id from List vendors). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed

Request body

application/json, required.

• first_namestringrequired

  The contact's first name.

• is_primarybooleanrequired

  Required, but not used.

• emailstring (email)
• faxstring

  Checked as a real number for fax_country.

• fax_countrystring
• last_namestring

  The contact's last name.

• phonestring

  Checked as a real number for phone_country.

• phone_countrystring

  Required with phone.

Response

200Successful response.

• dataobjectrequired
  Child fields (18)

  • created_atstring (date-time)required
  • first_namestring | nullrequired
  • idstringrequired
  • is_primarybooleanrequired
  • trashedbooleanrequired

    True when the contact is deleted.

  • updated_atstring (date-time)required
  • customer_idstring

    Customer contacts only.

  • default_receive_smsboolean
  • emailstring | null
  • external_typestring | null
  • faxstring | null
  • fax_countrystring | null
  • is_externalboolean

    True for a contact synced from Shopify; such contacts are read-only.

  • last_namestring | null
  • phonestring | null
  • phone_countrystring | null
  • send_invoiceboolean

    Customer contacts only.

  • vendor_idstring

    Vendor contacts only.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your role cannot update vendors. This 403 has a short body, {"message": "Insufficient Permission"}, with no success or error.

  Fix

  Ask a team owner to raise Manage Vendors for your role.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  first_name or is_primary is missing, or the phone is not valid for phone_country. error.code is validation_failed.

  Fix

  Fix each field named in error.fields; its keys are field paths such as contact.0.phone.

Related

• PATCHSet a vendor's primary contact/v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}/primary

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/vendor/EDhVUaC6jbLbed/contact' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "email": "riley@example.com",    "first_name": "Riley",    "is_primary": false,    "last_name": "Chen"  }'

Example response 200

Response

{
  "data": {
    "created_at": "2026-11-03T09:00:00+00:00",
    "default_receive_sms": false,
    "email": "riley@example.com",
    "external_type": null,
    "fax": null,
    "fax_country": null,
    "first_name": "Riley",
    "id": "Nd77ZXOndfLohn",
    "is_external": false,
    "is_primary": false,
    "last_name": "Chen",
    "phone": null,
    "phone_country": null,
    "trashed": false,
    "updated_at": "2026-11-03T09:00:00+00:00",
    "vendor_id": "MFwvMEIK7ud89l"
  },
  "status": 200,
  "success": true
}