---
updatedAt: 2026-05-27T16:33:01.000Z
agentTools:
  projectIndex: https://api.atsanywhere.io/llms.txt
---

# Create Custom Workflow

Create a custom workflow.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/companies/{company_id}/workflows": {
      "post": {
        "responses": {
          "201": {
            "description": "Create a custom workflow.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomWorkflow"
                }
              }
            }
          },
          "403": {
            "description": "Not authorized"
          },
          "404": {
            "description": "Record not found.  Please check to make sure that the specified ID is valid."
          },
          "422": {
            "description": "Fields were invalid or missing.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "errors": {
                      "type": "object",
                      "properties": {
                        "field_name": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "can't be blank"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal system error.  Please contact support in the event that this occurs."
          }
        },
        "summary": "Create Custom Workflow",
        "description": "Create a custom workflow.",
        "tags": [
          "Custom Workflows"
        ],
        "parameters": [
          {
            "name": "company_id",
            "in": "path",
            "description": "A company id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomWorkflowPayload"
              }
            }
          },
          "required": true
        }
      }
    }
  },
  "info": {
    "version": "1.0.0",
    "title": "Private Label API",
    "description": "Private Label API"
  },
  "servers": [
    {
      "url": "https://api.applicant-tracking.com/api/v1"
    }
  ],
  "components": {
    "schemas": {
      "CustomWorkflow": {
        "properties": {
          "id": {
            "type": "string",
            "example": "123"
          },
          "company_id": {
            "type": "string",
            "example": "456"
          },
          "name": {
            "type": "string",
            "example": "Sample Workflow"
          },
          "description": {
            "type": "string",
            "example": "This is a description of a custom workflow."
          },
          "workflow_type": {
            "type": "string",
            "example": "company"
          },
          "triggers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkflowTrigger"
            }
          },
          "created_at": {
            "type": "string",
            "example": "2018-01-08T06:34:48-08:00"
          },
          "updated_at": {
            "type": "string",
            "example": "2018-01-08T06:34:48-08:00"
          }
        }
      },
      "WorkflowTrigger": {
        "properties": {
          "id": {
            "type": "string",
            "example": "111"
          },
          "company_id": {
            "type": "string",
            "example": "456"
          },
          "custom_workflow_id": {
            "type": "string",
            "example": "123"
          },
          "event_type": {
            "type": "string",
            "example": "applicant_marked_as_hired"
          },
          "action_type": {
            "type": "string",
            "example": "tag_app"
          },
          "title": {
            "type": "string",
            "example": "Tag hired applicants"
          },
          "description": {
            "type": "string",
            "example": "Tags an applicant when they are marked as hired."
          },
          "state": {
            "type": "string",
            "example": "active"
          },
          "data": {
            "type": "object",
            "example": {
              "tag_text": "hired"
            }
          },
          "conditions": {
            "type": "object",
            "example": {}
          },
          "created_at": {
            "type": "string",
            "example": "2018-01-08T06:34:48-08:00"
          },
          "updated_at": {
            "type": "string",
            "example": "2018-01-08T06:34:48-08:00"
          }
        }
      },
      "CustomWorkflowPayload": {
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "Sample Workflow"
          },
          "description": {
            "type": "string",
            "example": "This is a description of a custom workflow.",
            "description": "On updates this attribute is always assigned: omitting it clears the stored description."
          }
        }
      }
    }
  }
}
```