updateAssociateRole

Update an existing associate role — pass its current version and an array of update actions.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the updateAssociateRole action (under Update).
Fill in the fields below, then reference the result from later steps as {{updateassociaterole.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 UpdateAssociateRole($version: Long!, $actions: [AssociateRoleUpdateAction!]!, $id: String, $key: String) {
  updateAssociateRole(version: $version, actions: $actions, id: $id, key: $key) {
    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.

versionstringrequired

actionsarray<object>required

addPermissionobject1 fields

changeBuyerAssignableobject1 fields

removePermissionobject1 fields

setCustomFieldobject2 fields

setCustomTypeobject4 fields

setNameobject1 fields

setPermissionsobject1 fields

idstring

Queries with specified ID

keystring

Queries with specified key

json

{
  "version": "string",
  "actions": [
    {
      "addPermission": {
        "permission": "string"
      },
      "changeBuyerAssignable": {
        "buyerAssignable": "string"
      },
      "removePermission": {
        "permission": "string"
      },
      "setCustomField": {
        "name": "string",
        "value": "string"
      },
      "setCustomType": {
        "fields": "string",
        "type": "string",
        "typeKey": "string",
        "typeId": "string"
      },
      "setName": {
        "name": "string"
      },
      "setPermissions": {
        "permissions": "string"
      }
    }
  ],
  "id": "string",
  "key": "string"
}

Response

Read the result with {{updateassociaterole.response.data.data.updateAssociateRole}}. If the API returns errors, the step fails and they are at {{updateassociaterole.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