API documentation

body format: request format:

    • Admin
    • Admin_btob
    • Application
    • Brands
    • BtoB
    • Campaigns
    • Campaigns (Blog)
    • Customer Api (deprecated)
    • Documents
    • External Forms
    • Form Answers
    • Forms
    • Guest forms
    • MailLogs
    • Medias
    • Members
    • Missions
    • Newsletters
    • Participations
    • Reminds
    • Reviews
    • Steps
    • Themes
    • Twa
    • Users
    • polymorph
  • Show/hide List Operations Expand Operations

    Admin

    • /api/admin/articles/{id_article}

        • GET /api/admin/articles/{id_article}

          • Return an article
          • Documentation
          • Sandbox

          Documentation

          Get campaign article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no article found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/articles/{id_article}

          • Update an article
          • Documentation
          • Sandbox

          Documentation

          Update an article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when bad request
          404
          • Returned when no article found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/articles/{id_article}/edit

        • GET /api/admin/articles/{id_article}/edit

          • Return a form to edit an article
          • Documentation
          • Sandbox

          Documentation

          Return a form to edit an article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no article found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/articles/{id_article}/remove

        • GET /api/admin/articles/{id_article}/remove

          • Return a form to create an article
          • Documentation
          • Sandbox

          Documentation

          Return a form to create an article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/brands

        • GET /api/admin/brands

          • Return a list of Brand objects
          • Documentation
          • Sandbox

          Documentation

          List all brands

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brands found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/brands

          • Create a new brand
          • Documentation
          • Sandbox

          Documentation

          Create a brand

          Status Codes

          Status Code Description
          201
          • Returned when the brand has successfully been created
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
           

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/brands/new

        • GET /api/admin/brands/new

          • Return a form to create a new brand
          • Documentation
          • Sandbox

          Documentation

          Return a form to create a brand

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/brands/{id_brand}

        • DELETE /api/admin/brands/{id_brand}

          • Delete a brand
          • Documentation
          • Sandbox

          Documentation

          Delete a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when the brand has successfully been removed
          400
          • The request contains errors
          404
          • Returned when not found
          409
          • The brand can not be removed because is associated to at least one campaign
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • GET /api/admin/brands/{id_brand}

          • Return a brand
          • Documentation
          • Sandbox

          Documentation

          Show a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/brands/{id_brand}

          • Update a brand
          • Documentation
          • Sandbox

          Documentation

          Update a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          201
          • Returned when the brand has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/brands/{id_brand}/edit

        • GET /api/admin/brands/{id_brand}/edit

          • Return a form to update a brand
          • Documentation
          • Sandbox

          Documentation

          Return a form to update a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
           

          Curl Command Line

          
          
    • /api/admin/brands/{id_brand}/remove

        • GET /api/admin/brands/{id_brand}/remove

          • Return a form to delete a brand
          • Documentation
          • Sandbox

          Documentation

          Return a form to delete a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns

        • GET /api/admin/campaigns

          • Return a list of Campaign objects
          • Documentation
          • Sandbox

          Documentation

          List all campaigns

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/campaigns

          • Create a campaign
          • Documentation
          • Sandbox

          Documentation

          Create a campaign

          Status Codes

          Status Code Description
          201
          • Returned when the campaign has successfully been created
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/categories

        • GET /api/admin/campaigns/categories

          • Return a list of categories campaign objects
          • Documentation
          • Sandbox

          Documentation

          List all categories

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no categories found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/categories/{id_category}

        • DELETE /api/admin/campaigns/categories/{id_category}

          • Delete a category
          • Documentation
          • Sandbox

          Documentation

          Delete a category

          Requirements

          Name Requirement Type Description
          id_category \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when the category has successfully been removed
          400
          • The request contains errors
          404
          • Returned when no category found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • GET /api/admin/campaigns/categories/{id_category}

          • Return a category
          • Documentation
          • Sandbox

          Documentation

          Show a category

          Requirements

          Name Requirement Type Description
          id_category \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no category found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/hidden

        • GET /api/admin/campaigns/hidden

          • Return a list of Campaign objects (not public)
          • Documentation
          • Sandbox

          Documentation

          List all hidden campaigns

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/hidden/data

        • GET /api/admin/campaigns/hidden/data

          • get additionals data
          • Documentation
          • Sandbox

          Documentation

          get additionals data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/impacts/theorical

        • GET /api/admin/campaigns/impacts/theorical

          • Return a list of Campaign impact theorical datas
          • Documentation
          • Sandbox

          Documentation

          List all theorical data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theorical datas found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/campaigns/impacts/theorical

          • Create a new theorical data
          • Documentation
          • Sandbox

          Documentation

          Create a theorical data

          Status Codes

          Status Code Description
          201
          • Returned when the theorical data has successfully been created
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/campaigns/impacts/theorical

          • Update a theorical data
          • Documentation
          • Sandbox

          Documentation

          Update a theorical data

          Status Codes

          Status Code Description
          201
          • Returned when the theorical data has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/impacts/theorical/edit

        • GET /api/admin/campaigns/impacts/theorical/edit

          • Return a form to update a theorical data
          • Documentation
          • Sandbox

          Documentation

          Return a form to update a theorical data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theorical data found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/impacts/theorical/new

        • GET /api/admin/campaigns/impacts/theorical/new

          • Return a form to create a new theorical data
          • Documentation
          • Sandbox

          Documentation

          Return a form to create a theorical data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theorical data found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/missions/{id_mission}/codes/import

        • POST /api/admin/campaigns/missions/{id_mission}/codes/import

          • Import promo code for mission promo code
          • Documentation
          • Sandbox

          Documentation

          Import promo code for mission promo code

          Requirements

          Name Requirement Type Description
          id_missoin \d+
          id_mission

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when mission not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/missions/{id_mission}/users/{id_user}/moderation/{moderation}

        • PUT /api/admin/campaigns/missions/{id_mission}/users/{id_user}/moderation/{moderation}

          • Moderate a user mission
          • Documentation
          • Sandbox

          Documentation

          Moderate a user mission

          Requirements

          Name Requirement Type Description
          id_mission \d+ int
          id_user \d+ int
          moderation \d+

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when moderation submitted does not exist or the mission can not be moderated
          404
          • Returned when no mission|user found
          Input

          Requirements

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/new

        • GET /api/admin/campaigns/new

          • Return an interface for campaign configuration
          • Documentation
          • Sandbox

          Documentation

          Return a form to create a campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/steps/allwithcampaigns

        • GET /api/admin/campaigns/steps/allwithcampaigns

          • Get all step with campaigns
          • Documentation
          • Sandbox

          Documentation

          Get a step by formId

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/steps/{id_step}

        • DELETE /api/admin/campaigns/steps/{id_step}

          • Delete steps of a campaign
          • Documentation
          • Sandbox

          Documentation

          Delete a step

          Requirements

          Name Requirement Type Description
          id_step \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when the submitted form contains errors
          404
          • Returned when no step found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • GET /api/admin/campaigns/steps/{id_step}

          • Get a step of a campaign
          • Documentation
          • Sandbox

          Documentation

          Get One step

          Requirements

          Name Requirement Type Description
          id_step \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}

        • DELETE /api/admin/campaigns/{id_campaign}

          • Delete a campaign
          • Documentation
          • Sandbox

          Documentation

          Delete a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when the campaign has successfully been removed
          400
          • The request contains errors
          404
          • Returned when no campaign found
          409
          • The campaign can not be removed because has already started
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • GET /api/admin/campaigns/{id_campaign}

          • Return a campaign
          • Documentation
          • Sandbox

          Documentation

          Show a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/campaigns/{id_campaign}

          • Update a campaign
          • Documentation
          • Sandbox

          Documentation

          Update a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when the campaign has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/articles

        • GET /api/admin/campaigns/{id_campaign}/articles

          • Return a list of Campaign articles
          • Documentation
          • Sandbox

          Documentation

          List campaign articles

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/campaigns/{id_campaign}/articles

          • Create an article
          • Documentation
          • Sandbox

          Documentation

          Create an article

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when bad request
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/articles/new

        • GET /api/admin/campaigns/{id_campaign}/articles/new

          • Return a form to create an article
          • Documentation
          • Sandbox

          Documentation

          Return a form to create an article

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/ban/users

        • POST /api/admin/campaigns/{id_campaign}/ban/users

          • Return array with number of new member ban and number of member already ban
          • Documentation
          • Sandbox

          Documentation

          Save ban user for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/clean/address

        • GET /api/admin/campaigns/{id_campaign}/clean/address

          • Return a list of winners postal address
          • Documentation
          • Sandbox

          Documentation

          Return a list of winners postal address

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/codes

        • POST /api/admin/campaigns/{id_campaign}/codes

          • Return a list of code objects for a campaign
          • Documentation
          • Sandbox

          Documentation

          Save code for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/codes/list

        • GET /api/admin/campaigns/{id_campaign}/codes/list

          • Return a list of code objects for a campaign
          • Documentation
          • Sandbox

          Documentation

          List all codes for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/codes/order

        • POST /api/admin/campaigns/{id_campaign}/codes/order

          • Return a list of order codes objects for a campaign
          • Documentation
          • Sandbox

          Documentation

          Save order codes for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/edit

        • GET /api/admin/campaigns/{id_campaign}/edit

          • Return an interface for campaign configuration
          • Documentation
          • Sandbox

          Documentation

          Return a form to update a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/filters/export

        • POST /api/admin/campaigns/{id_campaign}/filters/export

          • Create a CronRequest for generate export in backgroud
          • Documentation
          • Sandbox

          Documentation

          Create a CronRequest for generate export in background

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/filters/exportPowerPoint

        • POST /api/admin/campaigns/{id_campaign}/filters/exportPowerPoint

          • Create a CronRequest for generate export in backgroud
          • Documentation
          • Sandbox

          Documentation

          Create a CronRequest for generate export in background

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/filters/selection

        • POST /api/admin/campaigns/{id_campaign}/filters/selection

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/impacts

        • GET /api/admin/campaigns/{id_campaign}/impacts

          • Return impacts of a specific campaign
          • Documentation
          • Sandbox

          Documentation

          Get impacts of a specific campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no impacts found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/campaigns/{id_campaign}/impacts

          • Create a new campaign's impact
          • Documentation
          • Sandbox

          Documentation

          Create a campaign's impact

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          201
          • Returned when the campaign's impact has successfully been created
          400
          • Returned when form has errors
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/campaigns/{id_campaign}/impacts

          • Update a campaign's impact
          • Documentation
          • Sandbox

          Documentation

          Update a campaign's impact

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          201
          • Returned when the campaign's impact has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/impacts/edit

        • GET /api/admin/campaigns/{id_campaign}/impacts/edit

          • Return a form to update a campaign's impact
          • Documentation
          • Sandbox

          Documentation

          Return a form to update a campaign's impact

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no impacts found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/impacts/new

        • GET /api/admin/campaigns/{id_campaign}/impacts/new

          • Return a form to create a new campaign's impact
          • Documentation
          • Sandbox

          Documentation

          Return a form to create a campaign's impact

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no impacts found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions

        • GET /api/admin/campaigns/{id_campaign}/missions

          • List the missions of a campaign
          • Documentation
          • Sandbox

          Documentation

          List the missions of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/campaigns/{id_campaign}/missions

          • Update missions of a campaign
          • Documentation
          • Sandbox

          Documentation

          Update all missions

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when the submitted form contains errors
          404
          • Returned when no step found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/assign/users

        • POST /api/admin/campaigns/{id_campaign}/missions/assign/users

          • Assign a list of missions for a list of users
          • Documentation
          • Sandbox

          Documentation

          Assign a list of missions for a list of users

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when users|missions is not an array
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/edit

        • GET /api/admin/campaigns/{id_campaign}/missions/edit

          • Return an interface to configure missions of a campaign
          • Documentation
          • Sandbox

          Documentation

          Return a form to configure missions of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/logs

        • GET /api/admin/campaigns/{id_campaign}/missions/logs

          • Get the completed missions of campaign grouped by type with the filtered reference
          • Documentation
          • Sandbox

          Documentation

          Get the completed missions of campaign grouped b

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/logs/filter

        • GET /api/admin/campaigns/{id_campaign}/missions/logs/filter

          • Get filter log form by campaign or a new one if does not exist
          • Documentation
          • Sandbox

          Documentation

          Get filter log form by campaign or a new one if

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/logs/filter/delete

        • DELETE /api/admin/campaigns/{id_campaign}/missions/logs/filter/delete

          • Remove one filter log
          • Documentation
          • Sandbox

          Documentation

          Remove one filter log

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no filter log found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/logs/filter/update

        • PUT /api/admin/campaigns/{id_campaign}/missions/logs/filter/update

          • Update the filter table with the filtered reference
          • Documentation
          • Sandbox

          Documentation

          Update the filter table with the filtered refere

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/remove/{id_mission}

        • POST /api/admin/campaigns/{id_campaign}/missions/remove/{id_mission}

          • Remove a mission of a campaign
          • Documentation
          • Sandbox

          Documentation

          Remove a mission of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int
          id_mission \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
           

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/stats

        • GET /api/admin/campaigns/{id_campaign}/missions/stats

          • Get stats of campaign missions
          • Documentation
          • Sandbox

          Documentation

          Get stats of campaign missions

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when campaign|mission not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/missions/{id_mission}

        • GET /api/admin/campaigns/{id_campaign}/missions/{id_mission}

          • Return a mission
          • Documentation
          • Sandbox

          Documentation

          Return a mission

          Requirements

          Name Requirement Type Description
          id_mission \d+ int
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no mission found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/participations/cancel

        • PUT /api/admin/campaigns/{id_campaign}/participations/cancel

          • Cancel participations
          • Documentation
          • Sandbox

          Documentation

          Cancel participations

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Parameters

          Parameter Type Required? Format Description
          users [] true List of user id

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/participations/close

        • POST /api/admin/campaigns/{id_campaign}/participations/close

          • Close campaign participations
          • Documentation
          • Sandbox

          Documentation

          Close campaign participations

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when no campaign found
          409
          • Returned when campaign is already closed
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/participations/filters

        • GET /api/admin/campaigns/{id_campaign}/participations/filters

          • Return an interface for filter participations
          • Documentation
          • Sandbox

          Documentation

          Return an interface for filter participations

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campagne found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/campaigns/{id_campaign}/participations/filters

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Filters

          Name Information
          page
          Requirement \d+
          Description the page number
          Default 1
          number
          Requirement \d+
          Description number of results per page
          Default 25

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Filters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/participations/loser

        • PUT /api/admin/campaigns/{id_campaign}/participations/loser

          • Make users winner for a campaign
          • Documentation
          • Sandbox

          Documentation

          Make users loser for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Parameters

          Parameter Type Required? Format Description
          users [] true List of users id

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/participations/tracking

        • POST /api/admin/campaigns/{id_campaign}/participations/tracking

          • Upload Trackings campaign participations
          • Documentation
          • Sandbox

          Documentation

          Upload Trackings

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/participations/winner

        • PUT /api/admin/campaigns/{id_campaign}/participations/winner

          • Make users winner for a campaign
          • Documentation
          • Sandbox

          Documentation

          Make users winner for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Parameters

          Parameter Type Required? Format Description
          users [] true List of users id

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/reviews

        • GET /api/admin/campaigns/{id_campaign}/reviews

          • Return questions
          • Documentation
          • Sandbox

          Documentation

          Show a list of reviews

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Filters

          Name Information
          word
          Requirement
          Description null
          Default
          type
          Requirement
          Description null
          Default

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no questions found
          Input

          Requirements

          = -

          Filters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/stats

        • GET /api/admin/campaigns/{id_campaign}/stats

          • Return stats concerning the given campaign
          • Documentation
          • Sandbox

          Documentation

          Return stats concerning the given campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participants, thus no stats, found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/stats/filters

        • GET /api/admin/campaigns/{id_campaign}/stats/filters

          • Return an interface for filter stats
          • Documentation
          • Sandbox

          Documentation

          Return an interface for filter stats

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campagne found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/campaigns/{id_campaign}/stats/filters

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/stats/impacts

        • GET /api/admin/campaigns/{id_campaign}/stats/impacts

          • Return impact stats of a campaign
          • Documentation
          • Sandbox

          Documentation

          Return impact stats of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/stats/posts

        • GET /api/admin/campaigns/{id_campaign}/stats/posts

          • Return post stats of a campaign
          • Documentation
          • Sandbox

          Documentation

          Return post stats of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/stats/reviews

        • GET /api/admin/campaigns/{id_campaign}/stats/reviews

          • Return review stats of a campaign
          • Documentation
          • Sandbox

          Documentation

          Return review stats of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/steps

        • GET /api/admin/campaigns/{id_campaign}/steps

          • List the steps of a campaign
          • Documentation
          • Sandbox

          Documentation

          List the steps of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/campaigns/{id_campaign}/steps

          • Update steps of a campaign
          • Documentation
          • Sandbox

          Documentation

          Update a step

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when the submitted form contains errors
          404
          • Returned when no step found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/steps/edit

        • GET /api/admin/campaigns/{id_campaign}/steps/edit

          • Return an interface for campaign configuration
          • Documentation
          • Sandbox

          Documentation

          Return a form to update a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/users

        • GET /api/admin/campaigns/{id_campaign}/users

          • Return a list of campaign Participation
          • Documentation
          • Sandbox

          Documentation

          Return a list of campaign Participation

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/winners

        • GET /api/admin/campaigns/{id_campaign}/winners

          • Return all winners of a campaign
          • Documentation
          • Sandbox

          Documentation

          Return all winners of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Filters

          Name Information
          offset
          Requirement \d+
          Description offset of results
          Default 0
          limit
          Requirement \d+
          Description number of results
          Default 25
          filters
          Requirement []
          Description filters of results
          Default
          sorters
          Requirement []
          Description sorters of results
          Default

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Filters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/winnerscount

        • GET /api/admin/campaigns/{id_campaign}/winnerscount

          • Return all winners (not cancelled) of a campaign
          • Documentation
          • Sandbox

          Documentation

          Return count of winners (not canceled) for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/campaigns/{id_campaign}/winnersonly

        • GET /api/admin/campaigns/{id_campaign}/winnersonly

          • Return all winners (not cancelled) of a campaign
          • Documentation
          • Sandbox

          Documentation

          Return all winners (not canceled) of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/comments/{id_comment}/display/{display}

        • PUT /api/admin/comments/{id_comment}/display/{display}

          • Hide or show a comment
          • Documentation
          • Sandbox

          Documentation

          Hide or show a comment

          Requirements

          Name Requirement Type Description
          id_comment
          display

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when bad request
          404
          • Returned when no comment found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/customers/{id_user}

        • POST /api/admin/customers/{id_user}

          • add brand
          • Documentation
          • Sandbox

          Documentation

          Save brand

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          201
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/customers/{id_user}/campaigns

        • GET /api/admin/customers/{id_user}/campaigns

          • Return list of campaign,
          • Documentation
          • Sandbox

          Documentation

          get campaigns Brands for one User

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/customers/{id_user}/campaigns

          • add campaigns
          • Documentation
          • Sandbox

          Documentation

          Save campaigns

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          201
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/customers/{id_user}/campaigns/new

        • GET /api/admin/customers/{id_user}/campaigns/new

          • Return list of brand
          • Documentation
          • Sandbox

          Documentation

          Form get campaigns

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/customers/{id_user}/campaigns/{id_campaign}/remove

        • DELETE /api/admin/customers/{id_user}/campaigns/{id_campaign}/remove

          • delete campaign customer
          • Documentation
          • Sandbox

          Documentation

          remove campaigns customer

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int
          id_user

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/customers/{id_user}/new

        • GET /api/admin/customers/{id_user}/new

          • Return list of brand
          • Documentation
          • Sandbox

          Documentation

          Form get all brand

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/dashboard/{type}

        • GET /api/admin/dashboard/{type}

          • Return dashboard moderation data
          • Documentation
          • Sandbox

          Documentation

          Return dashboard moderation data

          Requirements

          Name Requirement Type Description
          type

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/documents

        • GET /api/admin/documents

          • Return all document
          • Documentation
          • Sandbox

          Documentation

          Return all document

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/documents/upload

        • GET /api/admin/documents/upload

          • Return an interface for uploading a document
          • Documentation
          • Sandbox

          Documentation

          Return a form to upload a document

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/documents/upload

          • Save a document uploaded
          • Documentation
          • Sandbox

          Documentation

          Save a document uploaded

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/documents/{id_document}

        • DELETE /api/admin/documents/{id_document}

          • Delete a document
          • Documentation
          • Sandbox

          Documentation

          Save a document uploaded

          Requirements

          Name Requirement Type Description
          id_document \d+

          Status Codes

          Status Code Description
          204
          • Returned when successful
          404
          • Document not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/export/campaigns/{id_campaign}/extern/reviews

        • GET /api/admin/export/campaigns/{id_campaign}/extern/reviews

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/export/campaigns/{id_campaign}/extern/reviews

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/export/campaigns/{id_campaign}/participations

        • GET /api/admin/export/campaigns/{id_campaign}/participations

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/export/campaigns/{id_campaign}/participations

          • Create a CronRequest for generate export in background
          • Documentation
          • Sandbox

          Documentation

          Create a CronRequest for generate export in background

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms

        • GET /api/admin/forms

          • Return list of all forms
          • Documentation
          • Sandbox

          Documentation

          Return list of forms

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/forms

          • Create a form
          • Documentation
          • Sandbox

          Documentation

          Create a form

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/export/{id_form}

        • POST /api/admin/forms/export/{id_form}

          • Create a request cron to export user, send result by email
          • Documentation
          • Sandbox

          Documentation

          User Export Request

          Requirements

          Name Requirement Type Description
          id_form \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/formfield/{id_formfield}

        • GET /api/admin/forms/formfield/{id_formfield}

          • Return a form field
          • Documentation
          • Sandbox

          Documentation

          Return a form field

          Requirements

          Name Requirement Type Description
          id_formfield \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no formfield found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/list/member/infos

        • GET /api/admin/forms/list/member/infos

          • Return list of member infos
          • Documentation
          • Sandbox

          Documentation

          Return list of member infos

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/member/info

        • POST /api/admin/forms/member/info

          • Create a form field for member information
          • Documentation
          • Sandbox

          Documentation

          Create a form field for member information

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/member/info/{id_info}

        • GET /api/admin/forms/member/info/{id_info}

          • Return one member info
          • Documentation
          • Sandbox

          Documentation

          Return one member info

          Requirements

          Name Requirement Type Description
          id_form \d+
          id_info

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/forms/member/info/{id_info}

          • Update a form field for member information
          • Documentation
          • Sandbox

          Documentation

          Update a form field for member information

          Requirements

          Name Requirement Type Description
          id_info \d+

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/new

        • GET /api/admin/forms/new

          • Return an interface to create a form
          • Documentation
          • Sandbox

          Documentation

          Return an interface to create a form

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/type/{formType}

        • GET /api/admin/forms/type/{formType}

          • Return list of all forms by type
          • Documentation
          • Sandbox

          Documentation

          Return list of forms for the type specified

          Requirements

          Name Requirement Type Description
          formType

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/{id_form}

        • DELETE /api/admin/forms/{id_form}

          • Delete a form
          • Documentation
          • Sandbox

          Documentation

          Delete a form

          Requirements

          Name Requirement Type Description
          id_form \d+

          Status Codes

          Status Code Description
          204
          • Returned when successful
          404
          • Document not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • GET /api/admin/forms/{id_form}

          • Return an interface to update a form
          • Documentation
          • Sandbox

          Documentation

          Return an interface to update a form

          Requirements

          Name Requirement Type Description
          id_form \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
           

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/forms/{id_form}

          • Update a form
          • Documentation
          • Sandbox

          Documentation

          Update a form

          Requirements

          Name Requirement Type Description
          id_form \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when form has errors
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/{id_form}/constraint

        • GET /api/admin/forms/{id_form}/constraint

          • Return an interface to add form constraint
          • Documentation
          • Sandbox

          Documentation

          Return an interface to add form constraint

          Requirements

          Name Requirement Type Description
          id_form \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/forms/{id_form}/constraint

          • Update form constraint
          • Documentation
          • Sandbox

          Documentation

          Update form constraint

          Requirements

          Name Requirement Type Description
          id_form \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when form has errors
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/{id_form}/duplicate

        • GET /api/admin/forms/{id_form}/duplicate

          • Duplicate a form
          • Documentation
          • Sandbox

          Documentation

          Duplicate a form

          Requirements

          Name Requirement Type Description
          id_form \d+

          Status Codes

          Status Code Description
          204
          • Returned when successful
          404
          • Document not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/{id_form}/preview

        • GET /api/admin/forms/{id_form}/preview

          • Return a form preview
          • Documentation
          • Sandbox

          Documentation

          Return a form preview

          Requirements

          Name Requirement Type Description
          id_form \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/forms/{id_form}/valid

        • POST /api/admin/forms/{id_form}/valid

          • Try to validate a form
          • Documentation
          • Sandbox

          Documentation

          Try to validate a form

          Requirements

          Name Requirement Type Description
          id_form \d+ int

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/media/delete

        • DELETE /api/admin/media/delete

          • Delete a media by id
          • Documentation
          • Sandbox

          Documentation

          Delete a media by id

          Status Codes

          Status Code Description
          200
          • Returned when successful
          204
          • Returned when no content
          304
          • Returned when no content modified
          400
          • Returned when bad request
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/media/list

        • GET /api/admin/media/list

          • get list of media
          • Documentation
          • Sandbox

          Documentation

          get list of media

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/campaign/{id_mission}/media/moderate/{moderate}

        • PUT /api/admin/moderation/campaign/{id_mission}/media/moderate/{moderate}

          • Moderate media with an array of media id and a moderate value
          • Documentation
          • Sandbox

          Documentation

          Moderate media with an array of media id and a moderate value

          Requirements

          Name Requirement Type Description
          id_mission \d+ int
          moderate \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when media not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/crawler/campaigns/{id_campaign}/missions

        • GET /api/admin/moderation/crawler/campaigns/{id_campaign}/missions

          • Get missions with crawler
          • Documentation
          • Sandbox

          Documentation

          Get missions with crawler

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when mission has no crawler configured
          404
          • Returned when mission not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/crawler/campaigns/{id_campaign}/stats

        • GET /api/admin/moderation/crawler/campaigns/{id_campaign}/stats

          • Get stats missions crawler
          • Documentation
          • Sandbox

          Documentation

          Get stats missions crawler

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Filters

          Name Information
          limitDate
          Description limit date, today by default

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when mission has no crawler configured
          404
          • Returned when mission not found
          Input

          Requirements

          = -

          Filters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/crawler/missions/{id_mission}/comparator

        • GET /api/admin/moderation/crawler/missions/{id_mission}/comparator

          • Get Comparator for crawler mission
          • Documentation
          • Sandbox

          Documentation

          Get Comparator for crawler mission

          Requirements

          Name Requirement Type Description
          id_mission \d+ int

          Filters

          Name Information
          moderation
          Description state of moderation

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when mission has no crawler configured
          404
          • Returned when mission not found
          Input

          Requirements

          = -

          Filters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/crawler/missions/{id_mission}/reset

        • POST /api/admin/moderation/crawler/missions/{id_mission}/reset

          • Get Comparator for crawler mission
          • Documentation
          • Sandbox

          Documentation

          Reset moderation for refused Crawler reviews

          Requirements

          Name Requirement Type Description
          id_mission \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/crawler/missions/{id_mission}/validate

        • PUT /api/admin/moderation/crawler/missions/{id_mission}/validate

          • Get Comparator for crawler mission
          • Documentation
          • Sandbox

          Documentation

          Put a formUser in status ACCEPTED and attribute the concerned review

          Requirements

          Name Requirement Type Description
          id_mission \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when a ressource is missing
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/crawler/reviews/{id_review}

        • DELETE /api/admin/moderation/crawler/reviews/{id_review}

          • Delete a crawler review
          • Documentation
          • Sandbox

          Documentation

          Delete a crawler review

          Requirements

          Name Requirement Type Description
          id_review \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when review is assigned
          404
          • Returned when a ressource is missing
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/crawler/reviews/{id_review}/cancel

        • PUT /api/admin/moderation/crawler/reviews/{id_review}/cancel

          • Put a formUser in status IN MODERATION and remove review attribution
          • Documentation
          • Sandbox

          Documentation

          Put a formUser in status IN MODERATION and remove review attribution

          Requirements

          Name Requirement Type Description
          id_review \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when a ressource is missing
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/media/campaign/{id_campaign}/missions

        • GET /api/admin/moderation/media/campaign/{id_campaign}/missions

          • Get all mission type media for a campaign
          • Documentation
          • Sandbox

          Documentation

          Get all mission type media for a campaign

          Requirements

          Name Requirement Type Description
          id_mission \d+
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when mission not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/media/mission/{id_mission}/sorted

        • GET /api/admin/moderation/media/mission/{id_mission}/sorted

          • Get all media sorted for a mission
          • Documentation
          • Sandbox

          Documentation

          Get all media sorted for a mission photo

          Requirements

          Name Requirement Type Description
          id_campaign \d+
          id_mission

          Filters

          Name Information
          offset
          Requirement \d+
          Description offset media
          Default 0
          limit
          Requirement \d+
          Description max result page
          Default 15
          moderationState
          Requirement \d+
          Description moderation state
          Default 0
          authorized
          Requirement \w+
          Description authorized state
          Default true
          favorite
          Requirement \w+
          Description favorite
          Default false

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when media not found
          Input

          Requirements

          = -

          = -

          Filters

          = -

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/media/send/publish/mail/campaign/{id_campaign}/user/{id_user}

        • POST /api/admin/moderation/media/send/publish/mail/campaign/{id_campaign}/user/{id_user}

          • Send publish mail
          • Documentation
          • Sandbox

          Documentation

          Send publish mail

          Requirements

          Name Requirement Type Description
          id_campaign \d+
          id_user \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/media/{id_media}/favorite/{favorite}

        • POST /api/admin/moderation/media/{id_media}/favorite/{favorite}

          • Change favorite state
          • Documentation
          • Sandbox

          Documentation

          Set favorite state

          Requirements

          Name Requirement Type Description
          id_media \d+
          favorite int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/reviews/campaign/{id_campaign}/count/{id_mission}

        • GET /api/admin/moderation/reviews/campaign/{id_campaign}/count/{id_mission}

          • Get the mission
          • Documentation
          • Sandbox

          Documentation

          Get reviews count by campaign id

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int
          id_mission \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when reviews not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/reviews/campaign/{id_campaign}/list/{id_mission}

        • GET /api/admin/moderation/reviews/campaign/{id_campaign}/list/{id_mission}

          • Get the mission
          • Documentation
          • Sandbox

          Documentation

          Get all reviews by campaign id

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int
          id_mission \d+

          Filters

          Name Information
          stateForm
          Requirement \d+
          Description state of the form
          Default 0
          stateReview
          Requirement \d+
          Description state of the review
          stateFavorite
          Requirement \d+
          Description state of the review

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when reviews not found
          Input

          Requirements

          = -

          = -

          Filters

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/reviews/formuser/{id_form_user}/moderate/{moderate}

        • PUT /api/admin/moderation/reviews/formuser/{id_form_user}/moderate/{moderate}

          • Moderate review with an id form user and a moderate value
          • Documentation
          • Sandbox

          Documentation

          Moderate review with an id form user and a moderate value

          Requirements

          Name Requirement Type Description
          id_form_user \d+ int
          moderate \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when media not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/moderation/reviews/review_id/{reviewId}/favorite/{favorite}

        • GET /api/admin/moderation/reviews/review_id/{reviewId}/favorite/{favorite}

          • Change favorite state
          • Documentation
          • Sandbox

          Documentation

          Set favorite state

          Requirements

          Name Requirement Type Description
          reviewId \d+
          favorite \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          204
          • Returned when review not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/participations/live

        • GET /api/admin/participations/live

          • Get live participations stats
          • Documentation
          • Sandbox

          Documentation

          Get live participations stats

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no live participations
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/polymorph/edit/{page}

        • GET /api/admin/polymorph/edit/{page}

          • Returns a form of Polymorph
          • Documentation
          • Sandbox

          Documentation

          Get a Polymorph entity

          Requirements

          Name Requirement Type Description
          page \D+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/polymorph/save/{polymorph}

        • OPTIONS /api/admin/polymorph/save/{polymorph}

          • Returns a form of Polymorph
          • Documentation
          • Sandbox

          Documentation

          Save a Polymorph entity

          Requirements

          Name Requirement Type Description
          polymorph

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/polymorph/save/{polymorph}

          • Returns a form of Polymorph
          • Documentation
          • Sandbox

          Documentation

          Save a Polymorph entity

          Requirements

          Name Requirement Type Description
          polymorph

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/reminds

        • GET /api/admin/reminds

          • Return reminds
          • Documentation
          • Sandbox

          Documentation

          Return remind

          Filters

          Name Information
          type
          Description type of remind

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no reminds found
          Input

          Filters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/reminds

          • Add a remind for a specific mission
          • Documentation
          • Sandbox

          Documentation

          Add a remind for a specific mission

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          409
          • Returner when remind start date is to old
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/reminds/campaigns/{id_campaign}

        • GET /api/admin/reminds/campaigns/{id_campaign}

          • Return all campaign remind
          • Documentation
          • Sandbox

          Documentation

          Return all campaign remind

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Filters

          Name Information
          type
          Description type of remind

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign|mission found
          Input

          Requirements

          = -

          Filters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/reminds/campaigns/{id_campaign}/test/{id_date}/{id_month}/{id_year}

        • POST /api/admin/reminds/campaigns/{id_campaign}/test/{id_date}/{id_month}/{id_year}

          • Remind an user
          • Documentation
          • Sandbox

          Documentation

          Test remind an user

          Requirements

          Name Requirement Type Description
          id_user \d+
          id_campaign
          id_date
          id_month
          id_year

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when form has errors
          404
          • Returned when no user found
          Input

          Requirements

          = -

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/reminds/campaigns/{id_campaign}/users/{id_user}

        • POST /api/admin/reminds/campaigns/{id_campaign}/users/{id_user}

          • Remind an user
          • Documentation
          • Sandbox

          Documentation

          Remind an user

          Requirements

          Name Requirement Type Description
          id_user \d+ int
          id_campaign \d+

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when form has errors
          404
          • Returned when no user found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/reminds/new

        • GET /api/admin/reminds/new

          • Return remind create form
          • Documentation
          • Sandbox

          Documentation

          Return remind create form

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/reminds/{id_remind}

        • DELETE /api/admin/reminds/{id_remind}

          • Delete a remind
          • Documentation
          • Sandbox

          Documentation

          Delete a remind

          Requirements

          Name Requirement Type Description
          id_remind \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when successful
          404
          • Returned when no remind found
          409
          • Returned when remind has already been sent
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • GET /api/admin/reminds/{id_remind}

          • Return remind
          • Documentation
          • Sandbox

          Documentation

          Return remind

          Requirements

          Name Requirement Type Description
          id_remind \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no remind found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/reminds/{id_remind}

          • Update a remind
          • Documentation
          • Sandbox

          Documentation

          Update a remind

          Requirements

          Name Requirement Type Description
          id_remind \d+ int

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          404
          • Returned when no remind found
          409
          • Returner when remind is finished
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/reminds/{id_remind}/edit

        • GET /api/admin/reminds/{id_remind}/edit

          • Return remind update form
          • Documentation
          • Sandbox

          Documentation

          Return remind update form

          Requirements

          Name Requirement Type Description
          id_remind \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no remind found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/templates

        • GET /api/admin/templates

          • Return all mail template
          • Documentation
          • Sandbox

          Documentation

          Return all mail template

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/templates

          • Return all mail template
          • Documentation
          • Sandbox

          Documentation

          Create template

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/templates/blog/{id_template}/{id_campaign}/{id_article}

        • GET /api/admin/templates/blog/{id_template}/{id_campaign}/{id_article}

          • Return an Active Campaign mail template
          • Documentation
          • Sandbox

          Documentation

          Return an Mailjet mail template

          Requirements

          Name Requirement Type Description
          id_template \d+ int
          id_campaign
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no template found
          Input

          Requirements

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/templates/new

        • GET /api/admin/templates/new

          • Return all mail template
          • Documentation
          • Sandbox

          Documentation

          Return a new form mail template

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no template found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/templates/{id_template}

        • DELETE /api/admin/templates/{id_template}

          • Delete mail template
          • Documentation
          • Sandbox

          Documentation

          Delete mail template

          Requirements

          Name Requirement Type Description
          id_template \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when successful
          404
          • Returned when no template found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • GET /api/admin/templates/{id_template}

          • Return a mail template
          • Documentation
          • Sandbox

          Documentation

          Return a mail template

          Requirements

          Name Requirement Type Description
          id_template \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no template found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/templates/{id_template}

          • Update mail template
          • Documentation
          • Sandbox

          Documentation

          Update mail template

          Requirements

          Name Requirement Type Description
          id_template \d+ int

          Status Codes

          Status Code Description
          201
          • Returned when the template has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/templates/{id_template}/edit

        • GET /api/admin/templates/{id_template}/edit

          • Return a form to update a template
          • Documentation
          • Sandbox

          Documentation

          Return a form to update a template

          Requirements

          Name Requirement Type Description
          id_template \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/themes

        • GET /api/admin/themes

          • Return a list of Theme objects
          • Documentation
          • Sandbox

          Documentation

          List all themes

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no themes found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • POST /api/admin/themes

          • Create a new theme
          • Documentation
          • Sandbox

          Documentation

          Create a theme

          Status Codes

          Status Code Description
          201
          • Returned when the theme has successfully been created
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/themes/new

        • GET /api/admin/themes/new

          • Return a form to create a new theme
          • Documentation
          • Sandbox

          Documentation

          Return a form to create a theme

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theme found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/themes/{id_theme}

        • GET /api/admin/themes/{id_theme}

          • Return a theme
          • Documentation
          • Sandbox

          Documentation

          Show a theme

          Requirements

          Name Requirement Type Description
          id_theme \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theme found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
        • PUT /api/admin/themes/{id_theme}

          • Update a theme
          • Documentation
          • Sandbox

          Documentation

          Update a theme

          Requirements

          Name Requirement Type Description
          id_theme

          Status Codes

          Status Code Description
          201
          • Returned when the theme has successfully been updated
          400
          • Returned when form has errors
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/themes/{id_theme}/delete

        • GET /api/admin/themes/{id_theme}/delete

          • Delete a theme
          • Documentation
          • Sandbox

          Documentation

          Delete a theme

          Requirements

          Name Requirement Type Description
          id_theme \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theme found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/themes/{id_theme}/edit

        • GET /api/admin/themes/{id_theme}/edit

          • Return a form to update a theme
          • Documentation
          • Sandbox

          Documentation

          Return a form to update a theme

          Requirements

          Name Requirement Type Description
          id_theme \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theme found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users

        • GET /api/admin/users

          • Return a list of User objects
          • Documentation
          • Sandbox

          Documentation

          List all users

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
           
        • POST /api/admin/users

          • Create an user
          • Documentation
          • Sandbox

          Documentation

          Create an user

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no user found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/search/{search}

        • GET /api/admin/users/search/{search}

          • Search users by id, email, name or firstname
          • Documentation
          • Sandbox

          Documentation

          Search users by id, email, name or firstname

          Requirements

          Name Requirement Type Description
          search string

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no user found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/children

        • GET /api/admin/users/stats/children

          • Return all children stats informations
          • Documentation
          • Sandbox

          Documentation

          Get all children stats

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/connections

        • GET /api/admin/users/stats/connections

          • Return all connections stats informations
          • Documentation
          • Sandbox

          Documentation

          Get all connections stats

          Filters

          Name Information
          clientName
          Requirement
          Description client name
          Default sampleo

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Filters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/export

        • POST /api/admin/users/stats/export

          • Create a request cron to export user, send result by email
          • Documentation
          • Sandbox

          Documentation

          User Export Request

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/exportall

        • POST /api/admin/users/stats/exportall

          • Create a request cron to export user, send result by email
          • Documentation
          • Sandbox

          Documentation

          User Export Request Complete DB

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/participations

        • GET /api/admin/users/stats/participations

          • Return all candidatures stats informations
          • Documentation
          • Sandbox

          Documentation

          Get all candidatures stats

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/profiles

        • GET /api/admin/users/stats/profiles

          • Return all profiling stats informations
          • Documentation
          • Sandbox

          Documentation

          Get all profiles stats

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/registrations

        • GET /api/admin/users/stats/registrations

          • Return all registrations stats informations
          • Documentation
          • Sandbox

          Documentation

          Get all registrations stats

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/social/networks

        • GET /api/admin/users/stats/social/networks

          • Return all social networks stats informations
          • Documentation
          • Sandbox

          Documentation

          Get all social networks stats

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/stats/talents

        • GET /api/admin/users/stats/talents

          • Return all talents audience stats informations
          • Documentation
          • Sandbox

          Documentation

          Get all social networks stats

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user_link}/status

        • PUT /api/admin/users/{id_user_link}/status

          • Update user conflict status
          • Documentation
          • Sandbox

          Documentation

          Update user conflict status

          Requirements

          Name Requirement Type Description
          $id_user_link \d+
          id_user_link

          Status Codes

          Status Code Description
          201
          • Returned when the conflict status has successfully been updated
          404
          • Returned when not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}

        • GET /api/admin/users/{id_user}

          • Return user informations
          • Documentation
          • Sandbox

          Documentation

          Return user informations

          Requirements

          Name Requirement Type Description
          id_user \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no user found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/change/enabled

        • PUT /api/admin/users/{id_user}/change/enabled

          • Enable/Desable User
          • Documentation
          • Sandbox

          Documentation

          Enable/Desable User

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          201
          • Returned when the user's address is updated
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/conflicts

        • GET /api/admin/users/{id_user}/conflicts

          • Get conflict User link
          • Documentation
          • Sandbox

          Documentation

          Get user conflict

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          200
          • Returned conflict
          404
          • Returned when conflict not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/grant

        • PUT /api/admin/users/{id_user}/grant

          • Update user roles
          • Documentation
          • Sandbox

          Documentation

          Update User Role

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          201
          • Returned when the brand has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/grant/edit

        • GET /api/admin/users/{id_user}/grant/edit

          • Documentation
          • Sandbox

          Documentation

          Form Grant Roles

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/login

        • PUT /api/admin/users/{id_user}/login

          • Update user login
          • Documentation
          • Sandbox

          Documentation

          Update User Login

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          201
          • Returned when the user login has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/login/edit

        • GET /api/admin/users/{id_user}/login/edit

          • Return Form login User
          • Documentation
          • Sandbox

          Documentation

          Form login User

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/tags

        • PUT /api/admin/users/{id_user}/tags

          • Update user tags
          • Documentation
          • Sandbox

          Documentation

          Update User tags

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          201
          • Returned when the brand has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/tags/edit

        • GET /api/admin/users/{id_user}/tags/edit

          • Documentation
          • Sandbox

          Documentation

          Form to update tags

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/unlink

        • PUT /api/admin/users/{id_user}/unlink

          • unlink user's account
          • Documentation
          • Sandbox

          Documentation

          Unlink user's account

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          201
          • Returned when the user's account is unlinked
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/users/{id_user}/update/address

        • PUT /api/admin/users/{id_user}/update/address

          • Update user address
          • Documentation
          • Sandbox

          Documentation

          Update user address

          Requirements

          Name Requirement Type Description
          id_user \d+

          Status Codes

          Status Code Description
          201
          • Returned when the user's address is updated
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
  • Show/hide List Operations Expand Operations

    Admin_btob

    • /api/admin/btob/homepage

        • GET /api/admin/btob/homepage

          • Returns a view homepage BToB dashboard
          • Documentation
          • Sandbox

          Documentation

          Get HomepageBToB form for BToB backOffice

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/btob/homepage/push

        • POST /api/admin/btob/homepage/push

          • Returns a http code
          • Documentation
          • Sandbox

          Documentation

          push HomepageBToB form for BToB backOffice

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
           

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/btob/news

        • GET /api/admin/btob/news

          • Returns a view News BToB dashboard
          • Documentation
          • Sandbox

          Documentation

          Get NewsBToB form for BToB backOffice

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/btob/news/update

        • PUT /api/admin/btob/news/update

          • Returns a view BToB dashboard
          • Documentation
          • Sandbox

          Documentation

          Update NewsBToB

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/btob/press

        • GET /api/admin/btob/press

          • Returns a list of Press BToB dashboard
          • Documentation
          • Sandbox

          Documentation

          Get list of PressBToB for BToB backOffice

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/btob/press/delete

        • DELETE /api/admin/btob/press/delete

          • Delete a PressBToB by id
          • Documentation
          • Sandbox

          Documentation

          Delete a PressBToB by id

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/btob/press/edit

        • GET /api/admin/btob/press/edit

          • Returns a empty form of PressBToB
          • Documentation
          • Sandbox

          Documentation

          Get a form of PressBToB for BToB backOffice

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          

          Request body

          
          

          Response Headers [Expand] [Profiler]

          
          

          Response Body [Raw]

          
          

          Curl Command Line

          
          
    • /api/admin/btob/press/new

        • GET /api/admin/btob/press/new

          • Returns a empty form of PressBToB
          • Documentation
          • Sandbox

          Documentation

          Get a form of PressBToB for BToB backOffice

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          =