Admin

Record publisher agreement

Record that a publisher has signed the publisher agreement.

post/admin/publishers/{team_id}/agreement

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/admin/publishers/{team_id}/agreement
  • Auth: HTTP bearer

Path parameters

team_idstring uuid required
Example:47221566-bf8f-43b6-9cda-8fae9643fda5

Request body

agreement_documentstring

S3 key for the signed agreement PDF

Example request

{
  "agreement_document": "agreements/publisher-agreement-2024-01-15.pdf"
}

Response

Agreement recorded successfully

idstring uuid required
namestring required
slugstring required
referral_codestring nullable required
stripe_customer_idstring nullable required
team_type_idstring uuid nullable required
hubspot_company_idstring nullable required
pro_pricing_enabledboolean required
has_completed_onboardingboolean required
can_access_paid_media_listboolean required
is_publisherboolean required
daily_order_dispatch_enabledboolean required
agreement_documentstring nullable required
website_urlstring uri nullable required
publisher_pending_outlet_capinteger nullable required
outlet_ownership_proof_exemptboolean required
contact_emailstring email nullable required
billing_emailstring email nullable required

Example response

{
  "name": "Team A",
  "slug": "team-a-5500b34370e9",
  "referral_code": "TEAM-ABC123",
  "stripe_customer_id": "cus_ABc241X",
  "team_type_id": "123e4567-e89b-12d3-a456-426614174000",
  "hubspot_company_id": "123456789",
  "pro_pricing_enabled": true,
  "contact_email": "contact@team.com",
  "billing_email": "billing@team.com"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.