Delete a message template

DELETE/v2/api/store/{team_slug}/setting/message_template/{hash_id}

v2Operation ID v2_public_message_template_destroy

Deletes one of your saved templates for good. System templates can't be deleted: the call answers 500 delete_fail and changes nothing.

Permission

Needs the Manage Settings permission. The team owner always has it.

Side effects

• Team members who have YoPrint open see it disappear at once.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The message template. Its hash id from an earlier answer; there is no unique key for it.

  • Example DVubREua5aJkwh

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.

  When

  Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the key of a member whose role has Manage Settings, or the owner's.

• 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 template of your team has this id. error.code is null; error.message names the record type.

  Fix

  Use an id from the list.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  It is a system template: error.code delete_fail, error.message null. Nothing is deleted.

  Fix

  Edit it instead.

Related

• GETList message templates/v2/api/store/{team_slug}/setting/message_template

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template/DVubREua5aJkwh' \  -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
}