Content_requests

>>>

GET /api/v4}/content_requests
List of Content Requests

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "content_requests": [
    {
      "id": 1,
      "name": "content_request",
      "recipient": "content_request",
      "expiration_date": "2022-06-07T00:00:00.000Z",
      "status": "pending",
      "time_type": "One-Time",
      "link_for_copy": "/content_requests/4c38da5893b1f793",
      "token": "4c38da5893b1f793"
    },
    ...
  ],
  "meta": {
    "total_count": 5
  }
}

Params

Param name Description
pending
required

Validations:

  • Must be one of: true, false, 1, 0.
query
optional

Query for search by name or recipient, or prompt

Validations:

  • Must be a String
sort_by
optional

Validations:

  • Must be one of: created_at, name, recipient, expiration_date.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
page
optional

pagination page number, default: 1

Validations:

  • Must be a String
per_page
optional

item per_page items number, default: 10

Validations:

  • Must be a String
>>>

GET /api/v4/content_requests/:token
Get Content Request

Success response body ↑

{
  "id": 1,
  "name": "content_request1",
  "recipient": "content_request",
  "expiration_date": "2022-06-07T00:00:00.000Z",
  "status": "canceled",
  "time_type": "One-Time",
  "link_for_copy": "/content_requests/4c38da5893b1f793",
  "token": "4c38da5893b1f793",
  "user": {
      "id": 1,
      "email": "kruchina.vadim@gmail.com",
      "first_name": "Vadim",
      "last_name": "Kruchina",
      "avatar_image": null
  }
}

Params

Param name Description
token
required

Validations:

  • Must be a String
>>>

POST /api/v4/content_requests
Create Content Request

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  content_request: {
    name: "content_request",
    recipient: "content_request",
    "prompt": "content_request",
    "expiration_date": "2022/06/07",
    "time_type": "one_time"
  }
}

Success response body ↑

{
  "id": 1,
  "name": "content_request",
  "recipient": "content_request",
  "prompt": "content_request",
  "expiration_date": "2022-06-07T00:00:00.000Z",
  "status": "pending",
  "time_type": "One-Time",
  "link_for_copy": "/content_requests/4c38da5893b1f793",
  "token": "4c38da5893b1f793"
}

Params

Param name Description
content_request
required

Validations:

  • Must be a Hash
content_request[name]
required

Validations:

  • Must be a String
content_request[recipient]
required

Validations:

  • Must be a String
content_request[prompt]
required

Validations:

  • Must be a String
content_request[expiration_date]
required

Example: 2022/06/07

Validations:

  • Must be a String
content_request[time_type]
optional

Validations:

  • Must be one of: one_time, multi_use.
>>>

PUT /api/v4/content_requests/:id
Update Content Request

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "content_request": {
    "name": "updated_content_request",
    "recipient": "content_request",
    "prompt": "content_request",
    "expiration_date": "2022/07/07",
    "status": "canceled"
  }
}

Success response body ↑

{
  "id": 1,
  "name": "updated_content_request",
  "recipient": "content_request",
  "prompt": "content_request",
  "expiration_date": "2022-07-07T00:00:00.000Z",
  "status": "canceled",
  "time_type": "One-Time",
  "link_for_copy": "/content_requests/4c38da5893b1f793",
  "token": "4c38da5893b1f793"
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
content_request
required

Validations:

  • Must be a Hash
content_request[name]
optional

Validations:

  • Must be a String
content_request[recipient]
optional

Validations:

  • Must be a String
content_request[prompt]
optional

Validations:

  • Must be a String
content_request[expiration_date]
optional

Example: 2022/06/07

Validations:

  • Must be a String
content_request[status]
optional

Validations:

  • Must be one of: canceled.
>>>

PUT /api/v4/content_requests/:token/complete
Complete Content Request

Request body example ↑

{
  "media_files": [
    {
      "name": "image",
      "s3_key": "s3_key",
      "format_type": "png",
      "media_type": "photo",
      "size": 53324,
      "note": "SOME NOTES"
    },
    ...
  ]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
token
required

Validations:

  • Must be a String
media_files
required

Validations:

  • Must be an Array of nested elements
media_files[name]
required

Validations:

  • Must be a String
media_files[s3_key]
required

Validations:

  • Must be a String
media_files[format_type]
required

Media File extension

Validations:

  • Must be a String
media_files[media_type]
required

Media type of file

Validations:

  • Must be one of: photo, video.
media_files[size]
required

Validations:

  • Must be a Integer
>>>

DELETE /api/v4/content_requests/:id
Destroy Content Request

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer