From ab0e26047e33345a366d30535a0c1851cd6e449e Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Mon, 9 Oct 2023 11:58:16 +0200 Subject: [PATCH] Docs: Add send_access_code to exhibitors API --- doc/plugins/exhibitors.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/doc/plugins/exhibitors.rst b/doc/plugins/exhibitors.rst index 8dda67f992..aa4b03ca6f 100644 --- a/doc/plugins/exhibitors.rst +++ b/doc/plugins/exhibitors.rst @@ -461,6 +461,36 @@ Endpoints :statuscode 401: Authentication failure :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to change it. +.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/send_access_code/ + + Sends an email to the exhibitor with their access code. + + **Example request**: + + .. sourcecode:: http + + POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/send_access_code/ HTTP/1.1 + Host: pretix.eu + Accept: application/json, text/javascript + + + **Example response**: + + .. sourcecode:: http + + HTTP/1.1 204 No Content + Vary: Accept + + :param organizer: The ``slug`` field of the organizer to modify + :param event: The ``slug`` field of the event to modify + :param code: The ``id`` field of the exhibitor to send an email for + :statuscode 200: no error + :statuscode 400: The exhibitor does not have an email address associated + :statuscode 401: Authentication failure + :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource. + :statuscode 404: The requested exhibitor does not exist. + :statuscode 503: The email could not be sent. + .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/