createOrUpdateCustomObject

Create a custom object, or overwrite the existing one for the same container + key.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the createOrUpdateCustomObject action (under Create).
Fill in the fields below, then reference the result from later steps as {{createorupdatecustomobject.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 CreateOrUpdateCustomObject($draft: CustomObjectDraft!) {
  createOrUpdateCustomObject(draft: $draft) {
    container
    key
    value
    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

containerstringrequired

valuestringrequired

versionstring

json

{
  "draft": {
    "key": "string",
    "container": "string",
    "value": "string",
    "version": "string"
  }
}

Response

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

containerstring

keystring

valuestring

idstring

versionstring

createdAtstring

lastModifiedAtstring

createdByobject

isPlatformClientboolean

clientIdstring

externalUserIdstring

anonymousIdstring

customerRefobject2 fields

userRefobject2 fields

associateRefobject2 fields

attributedToobject3 fields

lastModifiedByobject