Create a publisher

POST

/api/v1/publishers

curl --request POST \
  --url https://external-api.moja-ai.com/api/v1/publishers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "street_address": "example", "city": "example", "state": "example", "zip_code": "example", "country": "example", "phone_number": "example", "email": "", "website": "", "timezone": "America/New_York", "block_calls_if_capped": true, "access_to_call_recordings": true, "disable_recordings": false, "is_active": true, "advanced_caps": [ {} ], "everflow_affiliate_id": "example", "external_id": "example" }'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Header Parameters

X-API-Key

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

PublisherCreate

object

name

required

Name

string

>= 1 characters

street_address

required

Street Address

string

city

required

City

string

state

required

State

string

zip_code

required

Zip Code

string

country

required

Country

string

phone_number

required

Phone Number

string

email

Email

string

""

website

Website

string

""

timezone

Timezone

string

default: America/New_York

block_calls_if_capped

required

Block Calls If Capped

boolean

access_to_call_recordings

required

Access To Call Recordings

boolean

disable_recordings

Disable Recordings

boolean

is_active

required

Is Active

boolean

advanced_caps

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

everflow_affiliate_id

Any of:

string

string

<= 255 characters

null

null

external_id

Any of:

string

string

>= 1 characters <= 64 characters

null

null

Responses

201

Successful Response

Media typeapplication/json

PublisherResponse

object

id

required

Id

string

org_id

required

Org Id

string

name

required

Name

string

street_address

required

Street Address

string

city

required

City

string

state

required

State

string

zip_code

required

Zip Code

string

country

required

Country

string

phone_number

required

Phone Number

string

email

required

Email

string

website

required

Website

string

timezone

required

Timezone

string

block_calls_if_capped

required

Block Calls If Capped

boolean

access_to_call_recordings

required

Access To Call Recordings

boolean

disable_recordings

Disable Recordings

boolean

is_active

required

Is Active

boolean

hourly

Hourly

integer

0

daily

Daily

integer

0

weekly

Weekly

integer

0

monthly

Monthly

integer

0

yearly

Yearly

integer

0

total

Total

integer

0

everflow_affiliate_id

Any of:

string

string

null

null

external_id

Any of:

string

string

null

null

created_at

Any of:

string

string format: date-time

null

null

updated_at

Any of:

string

string format: date-time

null

null

advanced_caps

Advanced Caps

Array<object>

object

key

additional properties

any

Example

{
  "disable_recordings": false,
  "hourly": 0,
  "daily": 0,
  "weekly": 0,
  "monthly": 0,
  "yearly": 0,
  "total": 0
}

400

Bad Request

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}