Delete a contact by id

DELETE/v1/api/store/{team_slug}/contact/{id}

v1Operation ID v1_public_contact_destroy

Deletes a customer or vendor contact. The primary contact can't be deleted: make another contact primary first.

Permission

Any member of the team.

Business rules

• Contacts synced from Shopify are read-only (422).

Side effects

• Sends the customer_contact.deleted webhook (this route sends it for vendor contacts too).
• For a customer contact, removes the Customer Portal access it gave for its customer, and any access denial with it. When the portal account then has no active access to any customer, its signed-in sessions end.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• idstringrequired

  The contact's id: a customer or vendor contact. A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example uAu3dAKIaHyAYk

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• 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.

• 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.

  When

  No live contact with this id. error.code is null and error.message names the record type.

  Fix

  Check the 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

  The contact is primary (error.code delete_fail, "The primary contact can't be removed. Set another contact as primary first."), or synced from Shopify (validation_error).

  Fix

  Set another contact as primary first.

Related

• PATCHSet the primary contact/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}/primary
• PATCHRestore a deleted customer contact/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}/restore

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/contact/uAu3dAKIaHyAYk' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}