Request Options

List Request Options

get

List all request options.

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• type

• key

• value

• requestable_type

• requestable_id

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• type

• key

• value

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[type]stringOptional

Filter results by type.

filter[key]stringOptional

Filter results by key.

filter[value]stringOptional

Filter results by value.

filter[requestable_type]stringOptional

Filter results by requestable_type.

filter[requestable_id]stringOptional

Filter results by requestable_id.

sortstringOptional

Sort field. Prefix with - for descending. Available: type, key, value

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/request-options

HTTPcURLJavaScriptPython

GET /api/v1/request-options HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "type": "example_type",
      "key": "example_key",
      "value": "example_value",
      "requestable_type": "example_requestable_type",
      "requestable_id": 1,
      "configurable": "example_configurable",
      "locked": "example_locked",
      "required": "example_required",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "alias": "example_alias"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/request-options",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/request-options?page=1",
    "last": "https://api.example.com/api/v1/request-options?page=1",
    "prev": null,
    "next": null
  }
}

Create Request Option

post

Create a new request option.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
type	string	☑
key	string	☑
value	string	☑
requestable_type	string	☑
requestable_id	integer	☑
configurable
locked
required

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

application/json

typestringRequired

keystringRequired

valuestringRequired

requestable_typestringRequired

requestable_idintegerRequired

configurablestring · nullableOptional

lockedstring · nullableOptional

requiredstring · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/request-options

HTTPcURLJavaScriptPython

POST /api/v1/request-options HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "type": "text",
  "key": "text",
  "value": "text",
  "requestable_type": "text",
  "requestable_id": 1,
  "configurable": "text",
  "locked": "text",
  "required": "text"
}

{
  "data": {
    "id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "requestable_type": "example_requestable_type",
    "requestable_id": 1,
    "configurable": "example_configurable",
    "locked": "example_locked",
    "required": "example_required",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "alias": "example_alias"
  }
}

Get Request Option

get

Get a single request option.

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• type

• key

• value

• requestable_type

• requestable_id

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• type

• key

• value

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

request_optionstringRequired

The request option identifier.

Query parameters

filter[type]stringOptional

Filter results by type.

filter[key]stringOptional

Filter results by key.

filter[value]stringOptional

Filter results by value.

filter[requestable_type]stringOptional

Filter results by requestable_type.

filter[requestable_id]stringOptional

Filter results by requestable_id.

sortstringOptional

Sort field. Prefix with - for descending. Available: type, key, value

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/request-options/{request_option}

HTTPcURLJavaScriptPython

GET /api/v1/request-options/{request_option} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "requestable_type": "example_requestable_type",
    "requestable_id": 1,
    "configurable": "example_configurable",
    "locked": "example_locked",
    "required": "example_required",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "alias": "example_alias"
  }
}

Update Request Option

put

Update an existing request option.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
type	string
key	string
value	string

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

request_optionstringRequired

The request option identifier.

Body

application/json

typestringOptional

keystringOptional

valuestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/request-options/{request_option}

HTTPcURLJavaScriptPython

PUT /api/v1/request-options/{request_option} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "type": "text",
  "key": "text",
  "value": "text"
}

{
  "data": {
    "id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "requestable_type": "example_requestable_type",
    "requestable_id": 1,
    "configurable": "example_configurable",
    "locked": "example_locked",
    "required": "example_required",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "alias": "example_alias"
  }
}

Delete Request Option

delete

Delete a request option.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

request_optionstringRequired

The request option identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/request-options/{request_option}

HTTPcURLJavaScriptPython

DELETE /api/v1/request-options/{request_option} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}