Projects/ContentOrders

Supported Formats

json
>>>

GET /api/project2s/:project_id/content_orders
Lists ContentOrders for Project.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
>>>

POST /api/content_orders/upload_for_preview

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Errors related to uploaded file.

Params

Param name Description
file
required

File to be uploaded

Validations:

  • Must be a File
>>>

GET /api/project2s/:project_id/content_orders/:id/for_editor
Retrieves ContentOrder for Editor.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
>>>

GET /api/content_orders/sample_output
Returns sample output for zapier

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
>>>

GET /api/content_orders/task_feed
Content Orders for task feed.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
filter
optional

public_only or private_only

Validations:

  • Must be a String
mobile
optional

whether called from a mobile or not (1/0)

Validations:

  • Must be a String
>>>

POST /api/content_orders/:id/block_user
Blocks user for specific roles

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Validations:

  • Must be a String
user_id
required

Validations:

  • Must be a String
roles
required

Validations:

  • Must be one of: writer, editor.
reasons
required

Validations:

  • Must be an array of any type
message
required

Validations:

  • Must be a String
>>>

GET /api/content_orders/:id/activities
Get content order activity history

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 ContentOrder Not Found.

Params

Param name Description
id
required

ContentOrder ID

Validations:

  • Must be a String
>>>

POST /api/content_orders/multiple_order_action
Performs an action on multiple content orders.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unknown action.

Params

Param name Description
batch_action
required

Action to be applied to content orders

Validations:

  • Must be a String
content_order_ids
required

Array of content order ids

Validations:

  • Must be an array of any type
>>>

GET /api/content_orders/sample_content
Returns loved by publishers sample content

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unknown action.

Params

Param name Description
template_id
required

Template Id to select content orders

Validations:

  • Must be a String
>>>

GET /api/project2s/:project_id/content_orders/:id
Retrieves ContentOrder.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
fields
optional

fields to be returned

Validations:

  • Must be a String
>>>

GET /api/project2s/:project_id/content_orders/:id/content_cache
Retrieves Content Cache.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
update_cache
optional

update_cache= true if always updated cache wanted

Validations:

  • Must be a String
>>>

POST /api/project2s/:project_id/content_orders
Creates ContentOrder for Project.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
422 Unprocessable Project Task.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
fields
optional

fields to be returned

Validations:

  • Must be a String
content_order
required

Content order parameter container

Validations:

  • Must be a Hash
content_order[template_id]
optional

Template ID

Validations:

  • Must be a String
content_order[domain_id]
optional

Domain ID

Validations:

  • Must be a String
content_order[language]
optional

Language

Validations:

  • Must be a String
content_order[order_type]
optional

Language

Validations:

  • Must be a String
content_order[keywords]
optional

Keywords

Validations:

  • Must be an array of any type
content_order[keyword_substitutes]
optional

Keyword Substitutes

Validations:

  • Must be an array of any type
content_order[source_url]
optional

Source Url

Validations:

  • Must be a String
content_order[target_url]
optional

Target Url

Validations:

  • Must be a String
content_order[external_id]
optional

External Id

Validations:

  • Must be a String
>>>

PUT /api/project2s/:project_id/content_orders/:id
Updates ContentOrder for Project.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
fields
optional

fields to be returned

Validations:

  • Must be a String
content_order
required

Content order parameter container

Validations:

  • Must be a Hash
content_order[template_id]
optional

Template ID

Validations:

  • Must be a String
content_order[domain_id]
optional

Domain ID

Validations:

  • Must be a String
content_order[language]
optional

Language

Validations:

  • Must be a String
content_order[order_type]
optional

Language

Validations:

  • Must be a String
content_order[keywords]
optional

Keywords

Validations:

  • Must be an array of any type
content_order[keyword_substitutes]
optional

Keyword Substitutes

Validations:

  • Must be an array of any type
content_order[source_url]
optional

Source Url

Validations:

  • Must be a String
content_order[target_url]
optional

Target Url

Validations:

  • Must be a String
content_order[external_id]
optional

External Id

Validations:

  • Must be a String
>>>

POST /api/project2s/:project_id/content_orders/:id/take_over
Takeover or refresh taking over.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
manager
optional

manager=true if manager take_over

Validations:

  • Must be a String
>>>

POST /api/project2s/:project_id/content_orders/:id/start
Start Content Order

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
>>>

POST /api/project2s/:project_id/content_orders/:id/send_forward
Sends the order forward in workflow.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
workflow_message
optional

Workflow Message

Validations:

  • Must be a String
workflow_checklist
optional

Workflow Checklist

Validations:

  • Must be an array of any type
approval_score
optional

Approval score

Validations:

  • Must be a Integer
task_type
required

task type

Validations:

  • Must be a String
>>>

POST /api/project2s/:project_id/content_orders/:id/send_back
Sends the order forward in workflow.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
workflow_message
optional

Workflow Message

Validations:

  • Must be a String
workflow_checklist
optional

Workflow Checklist

Validations:

  • Must be an array of any type
>>>

POST /api/project2s/:project_id/content_orders/:id/drop
Sends the order forward in workflow.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
workflow_message
optional

Workflow Message

Validations:

  • Must be a String
workflow_checklist
optional

Workflow Checklist

Validations:

  • Must be an array of any type
cancel_msg
optional

Cancel Message when reassigning.

Validations:

  • Must be a String
reasons
optional

Cancel reasons

Validations:

  • Must be an array of any type
>>>

POST /api/project2s/:project_id/content_orders/:id/flag
Sends the order forward in workflow.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
workflow_message
optional

Workflow Message

Validations:

  • Must be a String
workflow_checklist
optional

Workflow Checklist

Validations:

  • Must be an array of any type
>>>

POST /api/project2s/:project_id/content_orders/:id/pause
Pauses the content order.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
>>>

POST /api/project2s/:project_id/content_orders/:id/cancel
Cancels the content order.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
>>>

PATCH /api/project2s/:project_id/content_orders/:id/workflow_assign
Assigns actor to a workflow task.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
task_type
required

task type

Validations:

  • Must be a String
actor_id
required

actor_id to be assigned

Validations:

  • Must be a String
cancel_msg
optional

Cancel Message when reassigning.

Validations:

  • Must be a String
reasons
optional

Cancel reasons

Validations:

  • Must be an array of any type
>>>

PATCH /api/project2s/:project_id/content_orders/:id/toggle_published
Toggles between approved and published states

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 ContentOrder Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String
>>>

DELETE /api/project2s/:project_id/content_orders/:id
Delete ContentOrder for Project

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 Project Task Not Found.
422 Unprocessable ContentOrder.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Content Order ID

Validations:

  • Must be a String