Accounts

Supported Formats

json
>>>

PATCH /api/users/:user_id/accounts/:id/serpbook_key
Add serpbook key

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
user_id
required

User Id

Validations:

  • Must be a String
serpbook_api_key
required

Serpbook Key

Validations:

  • Must be a String
>>>

PATCH /api/users/:user_id/accounts/:id/tags
Add or remove tag

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
user_id
required

User Id

Validations:

  • Must be a String
tags
required

Tags

Validations:

  • Must be an array of any type
>>>

GET /api/users/:user_id/accounts/:id/serpbook_account_info

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
user_id
required

User Id

Validations:

  • Must be a String
>>>

POST /api/users/:user_id/accounts/:id/invite_member
Invite member to the account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
email
required

User email to send invitation

Validations:

  • Must be a String
>>>

PUT /api/users/:user_id/accounts/:id/member_role
Modify member role in the account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
member_id
required

User ID to modify role

Validations:

  • Must be a String
role
required

Member role name

Validations:

  • Must be a String
granted
required

Member role permission

Validations:

  • Must be a Boolean
>>>

GET /api/users/:user_id/accounts/:id/pending_member_invitations
Lists pending member invitations

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
>>>

DELETE /api/users/:user_id/accounts/:id/delete_member_invitation
Deletes pending member invitations

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
affiliate_id
required

Affiliate ID to remove from invitations

Validations:

  • Must be a String
>>>

GET /api/users/:user_id/accounts/:id/members
Lists account members

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
>>>

DELETE /api/users/:user_id/accounts/:id/delete_member
Remove account member

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
member_id
required

User ID to remove from membership

Validations:

  • Must be a String
>>>

GET /api/users/accounts/all
Lists all accounts

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
page
optional

Skip page number

Validations:

  • Must be a Integer
per_page
optional

Rows count to be displayed

Validations:

  • Must be a Integer
q
optional

Search term

Validations:

  • Must be a String
>>>

GET /api/users/:user_id/accounts
Lists current_user's accounts

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
user_id
required

User ID

Validations:

  • Must be a String
>>>

GET /api/users/:user_id/accounts/registered
Lists given user's registered accounts.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
user_id
required

User ID

Validations:

  • Must be a String
>>>

GET /api/users/:user_id/accounts/:id
Represents account's detail

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
user_id
required

User ID

Validations:

  • Must be a String
account
required

Account parameter container

Validations:

  • Must be an Array of nested elements
account[name]
optional

Account Name

Validations:

  • Must be a String
account[vat_no]
optional

Vat number

Validations:

  • Must be a String
account[crm_id]
optional

CRM ID

Validations:

  • Must be a String
account[billing_street]
optional

Billing Street

Validations:

  • Must be a String
account[billing_city]
optional

Billing City

Validations:

  • Must be a String
account[billing_province]
optional

Billing Province

Validations:

  • Must be a String
account[billing_code]
optional

Billing Code

Validations:

  • Must be a String
account[billing_country]
optional

Billing Country

Validations:

  • Must be a String
account[customer_id]
optional

Customer Id for accounting

Validations:

  • Must be a String
account[email]
optional

E-mail address

Validations:

  • Must be a String
account[cp_username]
optional

Copyscape Username

Validations:

  • Must be a String
account[cp_token]
optional

Copyscape Token

Validations:

  • Must be a String
account[cp_private_search]
optional

Allow private search

Validations:

  • Must be one of: true, false.
account[cp_public_search]
optional

Allow public search

Validations:

  • Must be one of: true, false.
account[cp_writer_upload]
optional

Allow writer to private upload

Validations:

  • Must be one of: true, false.
account[cp_editor_upload]
optional

Allow editor to private upload

Validations:

  • Must be one of: true, false.
account[cp_publisher_upload]
optional

Allow publisher to private upload

Validations:

  • Must be one of: true, false.
account[discount]
optional

Validations:

  • Must be a Integer
account[balance_limit]
optional

Cents

Validations:

  • Must be a Integer
account[is_company]
required

Validations:

  • Must be one of: true, false.
>>>

POST /api/users/:user_id/accounts
Creates User Account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unprocessable Document
404 User Not Found

Params

Param name Description
user_id
required

User ID

Validations:

  • Must be a String
account
required

Account parameter container

Validations:

  • Must be an Array of nested elements
account[name]
optional

Account Name

Validations:

  • Must be a String
account[vat_no]
optional

Vat number

Validations:

  • Must be a String
account[crm_id]
optional

CRM ID

Validations:

  • Must be a String
account[billing_street]
optional

Billing Street

Validations:

  • Must be a String
account[billing_city]
optional

Billing City

Validations:

  • Must be a String
account[billing_province]
optional

Billing Province

Validations:

  • Must be a String
account[billing_code]
optional

Billing Code

Validations:

  • Must be a String
account[billing_country]
optional

Billing Country

Validations:

  • Must be a String
account[customer_id]
optional

Customer Id for accounting

Validations:

  • Must be a String
account[email]
optional

E-mail address

Validations:

  • Must be a String
account[cp_username]
optional

Copyscape Username

Validations:

  • Must be a String
account[cp_token]
optional

Copyscape Token

Validations:

  • Must be a String
account[cp_private_search]
optional

Allow private search

Validations:

  • Must be one of: true, false.
account[cp_public_search]
optional

Allow public search

Validations:

  • Must be one of: true, false.
account[cp_writer_upload]
optional

Allow writer to private upload

Validations:

  • Must be one of: true, false.
account[cp_editor_upload]
optional

Allow editor to private upload

Validations:

  • Must be one of: true, false.
account[cp_publisher_upload]
optional

Allow publisher to private upload

Validations:

  • Must be one of: true, false.
account[discount]
optional

Validations:

  • Must be a Integer
account[balance_limit]
optional

Cents

Validations:

  • Must be a Integer
account[is_company]
required

Validations:

  • Must be one of: true, false.
>>>

PUT /api/users/:user_id/accounts/:id
Updates User Account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found
404 User Not Found
422 Unprocessable Document

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
user_id
required

User ID

Validations:

  • Must be a String
account
required

Account parameter container

Validations:

  • Must be an Array of nested elements
account[name]
optional

Account Name

Validations:

  • Must be a String
account[vat_no]
optional

Vat number

Validations:

  • Must be a String
account[crm_id]
optional

CRM ID

Validations:

  • Must be a String
account[billing_street]
optional

Billing Street

Validations:

  • Must be a String
account[billing_city]
optional

Billing City

Validations:

  • Must be a String
account[billing_province]
optional

Billing Province

Validations:

  • Must be a String
account[billing_code]
optional

Billing Code

Validations:

  • Must be a String
account[billing_country]
optional

Billing Country

Validations:

  • Must be a String
account[customer_id]
optional

Customer Id for accounting

Validations:

  • Must be a String
account[email]
optional

E-mail address

Validations:

  • Must be a String
account[cp_username]
optional

Copyscape Username

Validations:

  • Must be a String
account[cp_token]
optional

Copyscape Token

Validations:

  • Must be a String
account[cp_private_search]
optional

Allow private search

Validations:

  • Must be one of: true, false.
account[cp_public_search]
optional

Allow public search

Validations:

  • Must be one of: true, false.
account[cp_writer_upload]
optional

Allow writer to private upload

Validations:

  • Must be one of: true, false.
account[cp_editor_upload]
optional

Allow editor to private upload

Validations:

  • Must be one of: true, false.
account[cp_publisher_upload]
optional

Allow publisher to private upload

Validations:

  • Must be one of: true, false.
account[discount]
optional

Validations:

  • Must be a Integer
account[balance_limit]
optional

Cents

Validations:

  • Must be a Integer
account[is_company]
required

Validations:

  • Must be one of: true, false.
>>>

DELETE /api/users/:user_id/accounts/:id
Destroys User account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Account Not Found
404 User Not Found
422 Unprocessable Document

Params

Param name Description
id
required

Account ID

Validations:

  • Must be a String
user_id
required

User ID

Validations:

  • Must be a String