Ghostwriter Assignments

Endpoint Overview

GET /api/admin/channels/v4/ghostwriters/

List ghostwriter assignments

POST /api/admin/channels/v4/ghostwriters/

Create ghostwriter assignment

DELETE /api/admin/channels/v4/ghostwriters/batch

Delete multiple ghostwriter assignments

GET /api/admin/channels/v4/ghostwriters/{creator_user_id}/behalf-of/{behalf_of_user_id}

Get ghostwriter assignment

DELETE /api/admin/channels/v4/ghostwriters/{creator_user_id}/behalf-of/{behalf_of_user_id}

Delete ghostwriter assignment

List ghostwriter assignmentsexperimental

Requires authentication via bearer.

Allows users to search ghostwriter assignments. Ghostwriter assignments are used to authorize users (the ghostwriter) to post on behalf of other users.

Query Params

search_term string

A term that needs a match in either the ghostwriter's or behalf of user's first name, last name or department.

sort string[]

page_number integer

requested page for offset based pagination. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

Response Body

200 OK

Create ghostwriter assignmentexperimental

Requires authentication via bearer.

Allows a user to create a new ghostwriter assignment. A Ghostwriter can post on behalf of the specified user.

Request Body

creator_user_id stringrequired

Unique identifier of a user.

behalf_of_user_id stringrequired

Unique identifier of a user.

Response Body

200 OK

Error Codes

GHOSTWRITER_ASSIGNMENT_ALREADY_EXISTS
CREATOR_MUST_BE_DIFFERENT_FROM_BEHALF_OF

Delete multiple ghostwriter assignmentsexperimental

Requires authentication via bearer.

Allows to delete multiple ghostwriter assignments.

Request Body

items object[]

Response Body

200 OK

Get ghostwriter assignmentexperimental

Requires authentication via bearer.

Allows to retrieve a single ghostwriter assignment.

Path Params

creator_user_id stringrequired

Unique identifier of a user.

behalf_of_user_id stringrequired

Unique identifier of a user.

Response Body

200 OK

Error Codes

CREATOR_MUST_BE_DIFFERENT_FROM_BEHALF_OF

Delete ghostwriter assignmentexperimental

Requires authentication via bearer.

Allows to delete a single ghostwriter assignment.

Path Params

creator_user_id stringrequired

Unique identifier of a user.

behalf_of_user_id stringrequired

Unique identifier of a user.

Response Body

200 OK

Error Codes

CREATOR_MUST_BE_DIFFERENT_FROM_BEHALF_OF