younifyd
Menu

/api/colors (Execute color action)

Execute color action

POST/api/colors

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/colors (Execute color action) action (under ColorController).
  3. Fill in the fields below, then reference the result from later steps as {{apiColorsExecuteColorAction.response.data}}.

Request

Query parameters

actionstringrequired

One ofNONEREFRESH_ITEMSAMENDEDITEDIT_CANCELSAVELOAD_DOCSAVE_AND_CONFIRMLOAD_VIEW_DEFINITIONDONE_DOCSEND_TO_VENDORSEND_TO_BUYERMARK_AS_OUT_OF_SIGNATUREMARK_AS_SIGNEDSEND_REMINDER_TO_VENDORSUBMITSET_TO_ACTIVESET_TO_INACTIVESET_TO_CANCELEDSET_AS_DEFAULTMARK_AS_CONCEPTMARK_AS_COSTINGMARK_AS_ADOPTEDMARK_AS_FINALIZEDMARK_AS_QUOTEDMARK_AS_SHORTLISTEDREMOVE_FROM_SHORTLISTMARK_AS_CONFIRMTOBUYMARK_AS_REJECTTOBUYMARK_AS_REVISEMARK_AS_PROPOSEDMARK_AS_OVERRIDDENMARK_AS_SOURCINGMARK_AS_PHASE_1_TRACKING_COMPLETEDMARK_AS_DRAFTMARK_AS_OFFICIALMARK_AS_READY_FOR_ONBOARDINGMARK_AS_CONFIRMEDMARK_AS_DEFAULTMARK_AS_SUBMITTED

approvalTemplateIdstring

Request body

Enter the body as JSON in the step's Body field.

idstring
hexCodestring
refNostring
codestring
colorNamestring
serviceNostring
serviceNameobject
codestringrequired
namestring
versioninteger (int32)
customerReferenceNostring
json
{
  "id": "string",
  "hexCode": "string",
  "refNo": "string",
  "code": "string",
  "colorName": "string",
  "serviceNo": "string",
  "serviceName": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "customerReferenceNo": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{apiColorsExecuteColorAction.response.data.<field>}}.

idstring
hexCodestring
refNostring
codestring
colorNamestring
serviceNostring
serviceNameobject
codestringrequired
namestring
versioninteger (int32)
customerReferenceNostring
json
{
  "id": "string",
  "hexCode": "string",
  "refNo": "string",
  "code": "string",
  "colorName": "string",
  "serviceNo": "string",
  "serviceName": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "customerReferenceNo": "string"
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.

/api/colors (Execute color action) — TradeBeyond — Documentation