Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.18 KB

create-job-request.md

File metadata and controls

31 lines (22 loc) · 1.18 KB

Create Job Request

Represents a CreateJob request.

Structure

CreateJobRequest

Fields

Name Type Tags Description Getter
Job Job Required Represents a job that can be assigned to team members. This object defines the
job's title and tip eligibility. Compensation is defined in a job assignment
in a team member's wage setting.
Job getJob()
IdempotencyKey String Required A unique identifier for the CreateJob request. Keys can be any valid string,
but must be unique for each request. For more information, see
Idempotency.
Constraints: Minimum Length: 1, Maximum Length: 45
String getIdempotencyKey()

Example (as JSON)

{
  "idempotency_key": "idempotency-key-0",
  "job": {
    "is_tip_eligible": true,
    "title": "Cashier",
    "id": "id6",
    "created_at": "created_at4",
    "updated_at": "updated_at8"
  }
}