Remove a message participant

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

v1Operation ID v1_public_participant_destroy

Removes a person from an order's or purchase order's message thread, so they stop getting its emails and texts. Past messages still show them, marked removed (trashed: true). There is no restore; add them again with the order's participant operations.

Permission

Any member of the team, for any participant on the team.

Side effects

• They stop receiving the order's customer emails and texts.
• People with the order open see the change live.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• idstringrequired

  The participant's id, from the order's participant list. A hash id; unique keys and document numbers are refused with 404.

  • Example vKNPqQz8fsYDuT

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 participant of this team has this id, or it was already removed.

  Fix

  Use an id from the order's participant list.

Related

• POSTAdd a participant to an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participant
• GETGet a message participant/v1/api/store/{team_slug}/participant/{id}

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/participant/vKNPqQz8fsYDuT' \  -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
}