Use wide Scribeless API integration

With Ants & Apps platform you can connect Scribeless API with more than 4000 available apps, 600+ functional formulas to boost your productivity

Get Started for Free

Reference

  • auth

    • Authenticate user

      This action authenticate user

      POSTAuth

      Request body

      • grant_type*string

        grant_type

      • grant_type*string

        grant_type

      • apiKey*string

        Example: d290f1ee-6c54-4b01-90e6-d701748f0851

      • password*string

        Example: testPassword

      • user*string

        Example: [email protected]

      • grant_type*string

        grant_type

      • grant_type*string

        grant_type

      • grant_type*string

        grant_type

      • emailstring

        Example: [email protected]

      • passwordstring

        Example: test

      • client_idstring

        assigned client id

      • client_secretstring

        assigned client secret

      • Passwordstring

      • Usernamestring

      • client_idstring

        Klare API provided client_id

      • grant_typestring

        OAuth2 grant_type - `client_credentials` for B2B communication

      • client_idstring

        assigned client id

      • client_secretstring

        assigned client secret

      • emailstring

      • passwordstring

      • client_idstring

        assigned client id

      • client_secretstring

        assigned client secret

      • client_idstring

        assigned client id

      • client_secretstring

        assigned client secret

      • client_idstring

        assigned client id

      • client_secretstring

        assigned client secret

      Try this in action

  • campaign

    • Get a particular campaign

      This action get a particular campaign

      GETGetCampaign

      Request parameters

      • campaign_id*string

      • testing*string

        If true requests will modify the database however you will not be charged for any orders placed

      Try this in action

    • Create a new campaign

      This action create a new campaign

      POSTCreateCampaign

      Request parameters

      • testing*string

        If true requests will modify the database however you will not be charged for any orders placed

      Request body

      • contact_list_id*integer

      • name*string

      • send_time*string

        Example: 2018-01-23 15:00:06

      • template_id*integer

      • due_datestring

        Example: 31/01/2021

      • footer_fontstring

        Example: josefin

      • footer_textstring

        Example: Footer text

      • handwriting_stylestring

        Example: Jane

      • header_fontstring

        Example: josefin

      • header_imagestring

        Example: http://app.thehandwriting.company/static/images/your_logo.png

      • header_textstring

        Example: Header text

      • header_typestring

        Example: Logo

      • insertsstring

        Example: $5 Starbucks gift card

      • notesstring

        Example: Campaign notes

      • paper_sizestring

        Example: A5

      • productstring

        Example: Advanced

      • recipientsstring

      • return_addressstring

      • textstring

        Example: Hello {{{first name}}},This is a test!

      • titlestring

        Example: My campaign

      • channel_guidsstring

      • descriptionstring

      • group_guidstring

      • namestring

      • business_daysboolean

        true if you want the survey to be sent only during business days, or false if you want natural days.

      • drip_daysinteger

        choose 0 if you want the survey to be sent as a whole in just one block, or choose the number of dripping days if you want to enable dripping.

      • feedback_fwdstring

      • timezonestring

        timezone you want to apply to the survey

      Try this in action

    • Update a campaign

      This action update a campaign

      PUTUpdateCampaign

      Request parameters

      • campaign_id*string

      • testing*string

        If true requests will modify the database however you will not be charged for any orders placed

      Request body

      • recipientsstring

      • channel_guidsstring

      • descriptionstring

      • group_guidstring

      • namestring

      Try this in action

    • Delete a campaign

      This action delete a campaign

      DELETEDeleteCampaign

      Request parameters

      • campaign_id*string

      • testing*string

        If true requests will modify the database however you will not be charged for any orders placed

      Try this in action

  • campaigns

    • Get a list of a users campaigns

      This action get a list of a users campaigns

      GETGetCampaigns

      Request parameters

      • testing*string

        If true requests will modify the database however you will not be charged for any orders placed

      Try this in action

  • price

    • Price a campaign

      This action price a campaign

      POSTPriceCampaign

      Request parameters

      • testing*string

        If true requests will modify the database however you will not be charged for any orders placed

      Request body

      • due_datestring

        Example: 31/01/2021

      • footer_fontstring

        Example: osefin

      • footer_textstring

        Example: Footer text

      • handwriting_stylestring

        Example: Jane

      • header_imagestring

        Example: http://app.scribeless.co/static/images/your_logo.png

      • header_typestring

        Example: Logo

      • insertsstring

        Example: $5 Starbucks gift card

      • notesstring

        Example: Campaign notes

      • paper_sizestring

        Example: A5

      • productstring

        Example: Advanced

      • recipientsstring

      • return_addressstring

      • textstring

        Example: Hello {{{first name}}},This is a test!

      • titlestring

        Example: My campaign

      Try this in action