Partnership Agreements

Partnership agreements capture the commercial terms of a partnership — revenue share, referral fees, exclusivity, co-marketing, and contract and renewal dates — with full history per partner.

The Partnership Agreement Object

Field	Type	Description
id	uuid	Unique identifier of the agreement.
account_id	uuid	ID of the account that owns this agreement.
partnership_id	uuid	ID of the partnership this agreement governs.
label	string	Display label of the agreement.
revenue_share_pct	number?	Revenue share owed under the agreement, as a percentage (e.g. 15 = 15%).
referral_fee	int?	Flat referral fee under the agreement, in integer cents.
exclusivity	bool	Whether the agreement grants exclusivity.
co_marketing_terms	string	Free-text co-marketing terms.
contract_start	string?	Contract start date (ISO 8601 date, YYYY-MM-DD).
contract_end	string?	Contract end date (ISO 8601 date, YYYY-MM-DD).
renewal_date	string?	Upcoming renewal date (ISO 8601 date, YYYY-MM-DD).
status	string	Lifecycle status of the agreement. One of: draft, active, expired, terminated
created_at	datetime	Timestamp when the agreement was created (ISO 8601).
updated_at	datetime	Timestamp when the agreement was last updated (ISO 8601).
partnership_name	string	Name of the parent partnership (read-only, joined; populated on renewals listing).

Create a partnership agreement

Endpoint: partnership-agreements-create

Field	Type	Required	Description
partnership_id	string	No	ID of the partnership this agreement governs.
label	string	No	Display label of the agreement.
revenue_share_pct	number?	No	Revenue share owed, as a percentage (e.g. 15 = 15%).
referral_fee	int?	No	Flat referral fee in integer cents.
exclusivity	bool	No	Whether the agreement grants exclusivity.
co_marketing_terms	string	No	Free-text co-marketing terms.
contract_start	string?	No	Contract start date (ISO 8601 date, YYYY-MM-DD).
contract_end	string?	No	Contract end date (ISO 8601 date, YYYY-MM-DD).
renewal_date	string?	No	Upcoming renewal date (ISO 8601 date, YYYY-MM-DD).
status	string	No	Lifecycle status; defaults to draft when omitted. One of: draft, active, expired, terminated

curl -X POST https://api.driftwoodapp.com/api/partnership-agreements-create \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Delete a partnership agreement

Endpoint: partnership-agreements-delete

List agreements for a partnership

Endpoint: partnership-agreements-list

List upcoming agreement renewals

Endpoint: partnership-agreements-renewals

Update a partnership agreement

Endpoint: partnership-agreements-update

Field	Type	Required	Description
id	string	No	ID of the agreement to update.
label	string?	No	New display label.
revenue_share_pct	number?	No	New revenue share, as a percentage (e.g. 15 = 15%).
referral_fee	int?	No	New flat referral fee in integer cents.
exclusivity	bool?	No	New exclusivity flag.
co_marketing_terms	string?	No	New co-marketing terms.
contract_start	string?	No	New contract start date (ISO 8601 date, YYYY-MM-DD).
contract_end	string?	No	New contract end date (ISO 8601 date, YYYY-MM-DD).
renewal_date	string?	No	New renewal date (ISO 8601 date, YYYY-MM-DD).
status	string?	No	New lifecycle status. One of: draft, active, expired, terminated

curl -X POST https://api.driftwoodapp.com/api/partnership-agreements-update \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Error Codes

Code	Description
agreements.invalid_partnership_id	Invalid partnership id
partnerships.not_found	Not found
agreements.invalid_id	Invalid id
agreements.not_found	Not found