createAssociateRole

Create a new associate role.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the createAssociateRole action (under Create).
Fill in the fields below, then reference the result from later steps as {{createassociaterole.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CreateAssociateRole($draft: AssociateRoleDraft!) {
  createAssociateRole(draft: $draft) {
    key
    buyerAssignable
    name
    permissions
    custom {
      typeRef {
        typeId
        id
      }
      type {
        key
        nameAllLocales
        descriptionAllLocales
        resourceTypeIds
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
    }
    id
    version
    createdAt
    lastModifiedAt
    createdBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
    lastModifiedBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

draftobjectrequired

keystringrequired

namestring

buyerAssignablebooleanrequired

permissionsarray<string>

customobject4 fields

json

{
  "draft": {
    "key": "string",
    "buyerAssignable": false,
    "name": "string",
    "permissions": [
      "AcceptMyQuotes"
    ],
    "custom": {
      "typeId": "string",
      "typeKey": "string",
      "type": {
        "typeId": "string",
        "id": "string",
        "key": "string"
      },
      "fields": [
        "string"
      ]
    }
  }
}

Response

Read the result with {{createassociaterole.response.data.data.createAssociateRole}}. If the API returns errors, the step fails and they are at {{createassociaterole.response.data.errors}}.

keystring

buyerAssignableboolean

namestring

permissionsarray<string>

customobject

typeRefobject2 fields

typeobject10 fields

idstring

versionstring

createdAtstring

lastModifiedAtstring

createdByobject

isPlatformClientboolean

clientIdstring

externalUserIdstring

anonymousIdstring

customerRefobject2 fields

userRefobject2 fields

associateRefobject2 fields

attributedToobject3 fields

lastModifiedByobject