Company

Create a new company

post

Creates a new company with the provided name and assigns it to the specified or current user.

Body

application/json

namestringRequired

The name of the company to create.

Example: Example Company

user_idintegerOptional

Optional user ID to associate with the new company. Defaults to the current session user.

Example: 12345

Responses

200

success

application/json

post

/company

HTTPcURLJavaScriptPython

POST /company HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "name": "Example Company",
  "user_id": 12345
}

200

success

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}

Retrieve company details

get

Fetches the details of a company based on company ID, path, or invitation token.

Query parameters

company_idintegerOptional

The ID of the company to retrieve.

Example: 98765

pathstringOptional

The unique path of the company to retrieve.

Example: example-company

invitation_tokenstringOptional

The invitation token to retrieve the company associated with it.

Example: abc123def456

Responses

200

success

application/json

get

/company

HTTPcURLJavaScriptPython

GET /company HTTP/1.1
Host: api.taag.co
Accept: */*

200

success

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}

Update company details

put

Updates the details of an existing company based on the provided fields.

Body

application/json

company_idintegerRequired

The ID of the company to update.

Example: 98765

send_followup_lead_emailintegerOptional

Number of days to wait before sending a follow-up lead email.

Example: 7

custom_urlstringOptional

Custom URL for the company.

Example: https://customurl.com

lock_profilesinteger · enumOptional

Flag to lock profiles for the company.

Example: 0Possible values:

force_ssointeger · enumOptional

Flag to force Single Sign-On (SSO) for the company.

Example: 0Possible values:

signup_optionsarray · enumOptional

Options for signup, e.g., 'email_password', 'google'.

Example: ["email_password"]Possible values:

profiles_publicinteger · enumOptional

Flag to make profiles public.

Example: 0Possible values:

descriptionstringOptional

The description of the company.

Example: This is a description of the company.

image_profilestringOptional

URL or path to the company's profile image.

Example: https://some-domain/images/profile.png

image_bannerstringOptional

URL or path to the company's banner image.

Example: https://some-domain/images/banner.png

backgroundstringOptional

Hex code for the company's background color.

Example: #ffffff

iconsstringOptional

Hex code for the company's icon color.

Example: #000000

textstringOptional

Hex code for the company's text color.

Example: #333333

fontstringOptional

Font used for the company's branding.

Example: https://some-domain/fonts/some-font.ttf

namestringOptional

The updated name of the company.

Example: Updated Company Name

lead_form_settinginteger · enumOptional

Lead form setting (valid values are 0, 1, 2, 3).

Example: 1Possible values:

lead_form_custominteger · enumOptional

Indicates whether the lead form is customized.

Example: 0Possible values:

disable_lead_forminteger · enumOptional

Flag to disable the lead form.

Example: 0Possible values:

instant_lead_form_oninteger · enumOptional

Flag to instantly enable the lead form.

Example: 0Possible values:

user_email_unchangeableinteger · enumOptional

Flag to make user emails unchangeable.

Example: 1Possible values:

lead_opt_out_availableinteger · enumOptional

Flag to allow lead opt-out.

Example: 0Possible values:

languagestringOptional

Language setting for the company.

Example: en

lead_data_consent_email_textstringOptional

Text for lead data consent emails.

Example: Please provide consent to receive emails.

uneditable_profile_fieldsstring[]Optional

Fields that cannot be edited in the profile.

Example: ["email","username"]

only_show_own_leadinteger · enumOptional

Flag to only show leads owned by the user.

Example: 0Possible values:

user_idintegerOptional

ID of the user associated with the company.

Example: 12345

send_followup_lead_email_in_daysintegerOptional

Number of days to wait before sending a follow-up lead email.

Example: 7

lead_create_reminder_daysintegerOptional

Number of days to wait before sending a lead creation reminder.

Example: 15

lead_create_reminder_typestringOptional

Type of reminder for lead creation (null or 'email').

Example: email

pathstringOptional

Unique path for the company.

Example: new-path

lead_data_consent_requiredinteger · enumOptional

Flag to require consent for lead data.

Example: 0Possible values:

lead_form_field_orderinteger[]Optional

Array of form field IDs in the desired order.

Example: [1,2,3]

Responses

200

success

application/json

put

/company

HTTPcURLJavaScriptPython

PUT /company HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 986

{
  "company_id": 98765,
  "send_followup_lead_email": 7,
  "custom_url": "https://customurl.com",
  "lock_profiles": 0,
  "force_sso": 0,
  "signup_options": [
    "email_password"
  ],
  "profiles_public": 0,
  "description": "This is a description of the company.",
  "image_profile": "https://some-domain/images/profile.png",
  "image_banner": "https://some-domain/images/banner.png",
  "background": "#ffffff",
  "icons": "#000000",
  "text": "#333333",
  "font": "https://some-domain/fonts/some-font.ttf",
  "name": "Updated Company Name",
  "lead_form_setting": 1,
  "lead_form_custom": 0,
  "disable_lead_form": 0,
  "instant_lead_form_on": 0,
  "user_email_unchangeable": 1,
  "lead_opt_out_available": 0,
  "language": "en",
  "lead_data_consent_email_text": "Please provide consent to receive emails.",
  "uneditable_profile_fields": [
    "email",
    "username"
  ],
  "only_show_own_lead": 0,
  "user_id": 12345,
  "send_followup_lead_email_in_days": 7,
  "lead_create_reminder_days": 15,
  "lead_create_reminder_type": "email",
  "path": "new-path",
  "lead_data_consent_required": 0,
  "lead_form_field_order": [
    1,
    2,
    3
  ]
}

200

success

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}

Delete a company

delete

Deletes the company specified by the provided company ID.

Body

application/json

company_idintegerRequired

The ID of the company to delete.

Example: 98765

Responses

200

success

application/json

delete

/company

HTTPcURLJavaScriptPython

DELETE /company HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "company_id": 98765
}

200

success

{
  "status": "success"
}