Documentation Powered by Redocly

Automation (Apr 24, 2024 1:29:16 PM)

Download OpenAPI specification:Download

Welcome to Synerise API Reference! We hope that you'll enjoy your stay here.

If you need help with our services, feel free to contact us at support@synerise.com.

Authentication

JWT

Synerise uses JSON Web Token (JWT) as the authorization method. The token is generated by the auth/login endpoint. You need to include it in the Authorization header of your requests, with a Bearer prefix. See this simplified example of a call:

curl -X GET https://api.synerise.com/v4/clients \
-H 'Accept: application/json' \
-H 'Api-Version: 4.4' \
-H 'Authorization: Bearer eyJhbGciOiJSzZXIiLCJjdGQiOjE1NTI0NjMzMjg4NjIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsIm5tZSI' \
-H 'Content-Type: application/json'

Remember to include a space between Bearer and the token.

The token is valid for one hour (unless configured differently). You can request a refreshed key for the session by using the auth/refresh endpoint before the current token expires.

You can verify your JWT signature by using the public key.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

TrackerKey

Authorization by tracker key sent in a token query parameter. This may be the same key as used in the tracking code of the website. For details, see this article: https://help.synerise.com/developers/web/installation-and-configuration/#creating-a-tracking-code.

Security Scheme Type API Key
Query parameter name: token

Authorization

Methods to authorize and obtain JWT token required by our API endpoints

Refresh a Profile token

Retrieve a refreshed JWT Token to prolong the session.

The current token must still be active at the time of the request.

  • API consumers who can use this method: Profile (formerly client), Anonymous profile (formerly client)

  • This method does not require a Synerise authorization token.

Authorizations:
JWT
    Request Body schema: application/json
    apiKey
    required
    string

    Profile API key

    Responses

    Request samples

    Content type
    application/json
    {
    • "apiKey": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "token": "eyJhbGciOiinvalidI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU"
    }

    Authenticate as Profile

    Obtain a new JWT token for a Profile. If an account for the Profile does not exist and the identityProvider is different than SYNERISE, this request creates an account.

    • This method does not require a Synerise authorization token.
    Request Body schema: application/json
    apiKey
    required
    string

    Profile API key

    identityProvider
    required
    string
    Enum: "SYNERISE" "FACEBOOK" "OAUTH" "APPLE" "GOOGLE" "UNKNOWN"

    The identity provider.

    identityProviderToken
    string

    Third-party authentication token used to authenticate with the Identity Provider. Required if identityProvider is different than SYNERISE.

    email
    string

    Profile email. Required if identityProvider is SYNERISE and email is the unique identifier (default setting).

    customId
    any

    Profile customId. Required if identityProvider is SYNERISE and customId is the unique identifier (see https://help.synerise.com/docs/settings/configuration/non-unique-emails/).

    password
    string

    Profile password. Required if identityProvider is SYNERISE.

    uuid
    string

    Profile UUID. Required if identityProvider is SYNERISE.

    deviceId
    string

    Unique Android or iOS device ID

    object

    This object contains the marketing agreements of the Profile.

    You can also pass the values as strings ("true";"True"/"false";"False") or integers (1 for true and 0 for false).

    object

    This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration.

    If you want to send a date/time attribute for use in analytics, take the following into account:

    • The date/time should be formatted according to ISO 8601.
    • The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example:
      • 2023-10-09T12:00:00 doesn't have a timezone indicator and will be considered as a time in the workspace's time zone.
      • 2023-10-09T12:00:00+02:00 has a timezone indicator (+02:00), so the timezone of the workspace doesn't affect it.
      • 2023-10-09T12:00:00Z is a time in the UTC time zone (denoted by the Z at the end), so the timezone of the workspace doesn't affect it.

    WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored.

    Click to expand the list of reserved attributes email
    clientId
    phone
    customId
    uuid
    firstName
    lastName
    displayName
    company
    address
    city
    province
    zipCode
    countryCode
    birthDate
    sex
    avatarUrl
    anonymous
    agreements
    tags
    businessProfileId
    time
    ip
    source
    newsletter_agreement
    custom_identify
    firstname
    lastname
    created
    updated
    last_activity_date
    birthdate
    external_avatar_url
    displayname
    receive_smses
    receive_push_messages
    receive_webpush_messages
    receive_btooth_messages
    receive_rfid_messages
    receive_wifi_messages
    confirmation_hash
    ownerId
    zipCode
    anonymous_type
    country_id
    geo_loc_city
    geo_loc_country
    geo_loc_as
    geo_loc_country_code
    geo_loc_isp
    geo_loc_lat
    geo_loc_lon
    geo_loc_org
    geo_loc_query
    geo_loc_region
    geo_loc_region_name
    geo_loc_status
    geo_loc_timezone
    geo_loc_zip
    club_card_id
    type
    confirmed
    facebookId
    status
    tags
    Array of strings

    Tags can be used to group profiles.

    Responses

    Request samples

    Content type
    application/json
    {
    • "apiKey": "string",
    • "identityProvider": "SYNERISE",
    • "identityProviderToken": "string",
    • "email": "string",
    • "customId": null,
    • "password": "string",
    • "uuid": "string",
    • "deviceId": "string",
    • "agreements": {
      },
    • "attributes": { },
    • "tags": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
    }

    Authenticate as Profile (conditional)

    Obtain a new JWT token for a Profile.

    • If the account does not exist, an account is not created.

    • If any additional conditions are required for logging in, the response is HTTP200 and lists the conditions.

    • Note that using this endpoint requires authenticating as an anonymous Profile first.

    • This method does not require a Synerise authorization token.

    Authorizations:
    JWT
      Request Body schema: application/json
      apiKey
      required
      string

      Profile API key

      identityProvider
      required
      string
      Enum: "SYNERISE" "FACEBOOK" "OAUTH" "APPLE" "GOOGLE" "UNKNOWN"

      The identity provider.

      identityProviderToken
      string

      Third-party authentication token used to authenticate with the Identity Provider. Required if identityProvider is different than SYNERISE.

      email
      string

      Profile email. Required if identityProvider is SYNERISE and email is the unique identifier (default setting).

      customId
      any

      Profile customId. Required if identityProvider is SYNERISE and customId is the unique identifier (see https://help.synerise.com/docs/settings/configuration/non-unique-emails/).

      password
      string

      Profile password. Required if identityProvider is SYNERISE.

      uuid
      string

      Profile UUID. Required if identityProvider is SYNERISE.

      deviceId
      string

      Unique Android or iOS device ID

      object

      This object contains the marketing agreements of the Profile.

      You can also pass the values as strings ("true";"True"/"false";"False") or integers (1 for true and 0 for false).

      object

      This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration.

      If you want to send a date/time attribute for use in analytics, take the following into account:

      • The date/time should be formatted according to ISO 8601.
      • The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example:
        • 2023-10-09T12:00:00 doesn't have a timezone indicator and will be considered as a time in the workspace's time zone.
        • 2023-10-09T12:00:00+02:00 has a timezone indicator (+02:00), so the timezone of the workspace doesn't affect it.
        • 2023-10-09T12:00:00Z is a time in the UTC time zone (denoted by the Z at the end), so the timezone of the workspace doesn't affect it.

      WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored.

      Click to expand the list of reserved attributes email
      clientId
      phone
      customId
      uuid
      firstName
      lastName
      displayName
      company
      address
      city
      province
      zipCode
      countryCode
      birthDate
      sex
      avatarUrl
      anonymous
      agreements
      tags
      businessProfileId
      time
      ip
      source
      newsletter_agreement
      custom_identify
      firstname
      lastname
      created
      updated
      last_activity_date
      birthdate
      external_avatar_url
      displayname
      receive_smses
      receive_push_messages
      receive_webpush_messages
      receive_btooth_messages
      receive_rfid_messages
      receive_wifi_messages
      confirmation_hash
      ownerId
      zipCode
      anonymous_type
      country_id
      geo_loc_city
      geo_loc_country
      geo_loc_as
      geo_loc_country_code
      geo_loc_isp
      geo_loc_lat
      geo_loc_lon
      geo_loc_org
      geo_loc_query
      geo_loc_region
      geo_loc_region_name
      geo_loc_status
      geo_loc_timezone
      geo_loc_zip
      club_card_id
      type
      confirmed
      facebookId
      status
      tags
      Array of strings

      Tags can be used to group profiles.

      Responses

      Request samples

      Content type
      application/json
      {
      • "apiKey": "string",
      • "identityProvider": "SYNERISE",
      • "identityProviderToken": "string",
      • "email": "string",
      • "customId": null,
      • "password": "string",
      • "uuid": "string",
      • "deviceId": "string",
      • "agreements": {
        },
      • "attributes": { },
      • "tags": [
        ]
      }

      Response samples

      Content type
      application/json
      {
      • "conditions": [
        ],
      • "status": "SUCCESS",
      • "token": "string"
      }

      Authenticate anonymously

      Obtain a new JWT for an anonymous Profile. The token can be used and refreshed in the same way as tokens of registered Profiles.

      • This method does not require a Synerise authorization token.
      Request Body schema: application/json
      apiKey
      string

      Profile API key (same as for Profile login)

      deviceId
      string

      Unique Android or iOS device ID

      uuid
      string

      UUID of the Profile. It is a unique identifier.

      Responses

      Request samples

      Content type
      application/json
      {
      • "apiKey": "string",
      • "deviceId": "string",
      • "uuid": "07243772-008a-42e1-ba37-c3807cebde8f"
      }

      Response samples

      Content type
      application/json
      {
      • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
      }

      Log in as User

      Authenticate as a User.

      Note: To perform operations within a Workspace, you must select a Workspace.

      • This method does not require a Synerise authorization token.
      Request Body schema: application/json
      username
      required
      string

      The login (email address) of the user

      password
      required
      string

      The user's password

      deviceId
      string

      Identifier of user's current device

      externalProviderToken
      string
      externalProviderType
      string
      Value: "GOOGLE"

      Responses

      Request samples

      Content type
      application/json
      {
      • "username": "string",
      • "password": "string",
      • "deviceId": "string",
      • "externalProviderToken": "string",
      • "externalProviderType": "GOOGLE"
      }

      Response samples

      Content type
      application/json
      {
      • "consumer": {
        },
      • "token": "string"
      }

      Verify User multi-factor authentication

      Authenticate as a User with multi-factor authentication.

      Note: To perform operations within a Workspace, you must select a Workspace.

      • API consumer who can use this method: Synerise User

      • This method is available to all authenticated users, before and after multi-factor authentication is confirmed.

      Authorizations:
      JWT
        query Parameters
        mfaType
        required
        string
        Value: "TOTP_AUTHENTICATOR"

        Type of multi-factor authentication

        Request Body schema: application/json
        verificationCode
        required
        string

        Multi-factor verification code

        deviceId
        string
        externalProviderToken
        string
        externalProviderType
        string
        Value: "GOOGLE"

        Responses

        Request samples

        Content type
        application/json
        {
        • "verificationCode": "string",
        • "deviceId": "string",
        • "externalProviderToken": "string",
        • "externalProviderType": "GOOGLE"
        }

        Response samples

        Content type
        application/json
        {
        • "consumer": {
          },
        • "token": "string"
        }

        Select Workspace

        After logging in as a User, select a Workspace where you want to perform operations.

        • API consumer who can use this method: Synerise User

        • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

        Authorizations:
        JWT
          path Parameters
          businessProfileUUID
          required
          string <uuid>

          UUID of the workspace

          Responses

          Request samples 

          curl --request POST 
  --url https://api.synerise.com/uauth/auth/login/user/profile/%7BbusinessProfileUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

          Response samples

          Content type
          application/json
          {
          • "consumer": {
            },
          • "token": "string"
          }

          Get Workspaces

          Retrieve a list of Workspaces available to the user.

          • API consumer who can use this method: Synerise User

          • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

          Authorizations:
          JWT

            Responses

            Request samples 

            curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/ 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

            Response samples

            Content type
            application/json
            [
            • {
              }
            ]

            Get current Workspace

            Retrieve information about the currently selected workspace.

            • API consumer who can use this method: Synerise User

            • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

            Authorizations:
            JWT

              Responses

              Request samples 

              curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/current 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

              Response samples

              Content type
              application/json
              {
              • "businessProfileGuid": "string",
              • "logo": "string",
              • "name": "string",
              • "id": 0,
              • "created": "2019-08-24T14:15:22Z",
              • "subdomain": "string",
              • "ipRestricted": true,
              • "mfaRequired": true
              }

              Log in as Workspace

              Obtain a new Workspace JWT Token.

              • This method does not require a Synerise authorization token.
              Request Body schema: application/json
              apiKey
              required
              string

              Workspace API key

              Responses

              Request samples

              Content type
              application/json
              {
              • "apiKey": "64c09614-1b2a-42f7-804d-f647243eb1ab"
              }

              Response samples

              Content type
              application/json
              {
              • "token": "string"
              }

              Workflows

              Workflows let you build automation scenarios

              Get list of workflows

              Retrieve a paginated list of workflows.

              • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

              • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: AUTOMATON_BRAIN_DIAGRAM_LIST_READ

              • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: AUTOMATION_2_JOURNEYS

              Authorizations:
              JWT
                query Parameters
                page
                number >= 1
                Default: 1

                The selected page

                limit
                number
                Default: 10

                Selected page

                filter
                string
                Default: "All"
                Enum: "All" "Recent" "Draft" "Active" "Inactive" "Scheduled"

                Filter workflows by status

                sort
                string
                Default: "UpdatedTime"
                Enum: "Author" "Name" "CreatedTime" "UpdatedTime"

                Sort workflows by a property value

                order
                string
                Default: "Desc"
                Enum: "Asc" "Desc"

                Sorting order

                search
                string

                A string to search for in workflow names and email addresses of authors. Workflows that don't match the search aren't returned at all.

                Responses

                Request samples 

                curl --request GET 
  --url 'https://api.synerise.com/automation-brain/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&filter=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

                Response samples

                Content type
                application/json
                {
                • "data": [
                  ],
                • "meta": {
                  }
                }

                Run/resume workflow

                Run a or resume workflow.

                • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

                • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE

                • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: AUTOMATION_2_JOURNEYS

                Authorizations:
                JWT
                  path Parameters
                  diagramId
                  required
                  string

                  UUID of the workflow/diagram.

                  Responses

                  Request samples 

                  curl --request POST 
  --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/run 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

                  Response samples

                  Content type
                  application/json
                  {
                  • "path": "string",
                  • "timestamp": "2019-08-24T14:15:22Z",
                  • "errorCode": "string",
                  • "status": 0,
                  • "message": "string",
                  • "traceId": "string"
                  }

                  Pause workflow

                  Pause a workflow.

                  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

                  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE

                  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: AUTOMATION_2_JOURNEYS

                  Authorizations:
                  JWT
                    path Parameters
                    diagramId
                    required
                    string

                    UUID of the workflow/diagram.

                    Responses

                    Request samples 

                    curl --request POST 
  --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/pause 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

                    Response samples

                    Content type
                    application/json
                    {
                    • "path": "string",
                    • "timestamp": "2019-08-24T14:15:22Z",
                    • "errorCode": "string",
                    • "status": 0,
                    • "message": "string",
                    • "traceId": "string"
                    }

                    Stop workflow

                    Stop a workflow.

                    WARNING: A stopped workflow can't be restarted.

                    • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

                    • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE

                    • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: AUTOMATION_2_JOURNEYS

                    Authorizations:
                    JWT
                      path Parameters
                      diagramId
                      required
                      string

                      UUID of the workflow/diagram.

                      Responses

                      Request samples 

                      curl --request POST 
  --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/stop 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

                      Response samples

                      Content type
                      application/json
                      {
                      • "path": "string",
                      • "timestamp": "2019-08-24T14:15:22Z",
                      • "errorCode": "string",
                      • "status": 0,
                      • "message": "string",
                      • "traceId": "string"
                      }

                      Data Processing Job Logs

                      If your workflow includes nodes for data processing (pulling or pushing data, Data Transformation, imports into Synerise), logs can help you with troubleshooting.

                      Get last log with stages

                      Retrieve the status of a workflow's last run and its stages.

                      The workflow must contain at least one of the following nodes:

                      • Any Data Transformation node
                      • Any node that pulls data into a workflow (for example local file, SFTP, Azure Blob Storage)
                      • Any node that pushes data out of the workflow (for example SFTP, Pub/Sub)
                      • Any node that imports data into Synerise

                      • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

                      • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: MORPH_JOBS_READ

                      • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: AUTOMATION_2_JOURNEYS

                      Authorizations:
                      JWT
                        path Parameters
                        automationWorkflowId
                        required
                        string <uuid>

                        diagramId of the workflow to fetch last job from

                        query Parameters
                        limit
                        number <= 5000
                        Default: 500

                        The maximum number of log lines in each stage

                        Responses

                        Request samples 

                        curl --request GET 
  --url 'https://api.synerise.com/morph/logs/automation/%7BautomationWorkflowId%7D/last-run/with-stages?limit=SOME_NUMBER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

                        Response samples

                        Content type
                        application/json
                        {
                        • "startTime": "2019-08-24T14:15:22Z",
                        • "runId": "78c33d18-170c-44d3-a227-b3194f134f73",
                        • "pipelineResponse": {
                          },
                        • "overallRunStatus": "Pending"
                        }