Subscriptions Support

Create subscription for workspace

Associate the workspace with chargebee subscription

post/support/workspaces/{workspace_id}/sms

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/support/workspaces/{workspace_id}/sms
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Id of the workspace to work with

Example:4

Request body

first_namestring nullable

First Name of the customer

last_namestring nullable

Last Name of the customer

emailstring email nullable

Email of the customer

company_namestring nullable

Company of the customer

plan_idstring required

Plan ID of the customer

customer_idstring nullable

ID of the customer

Example request

{
  "first_name": "TestUser",
  "last_name": "TestUser",
  "email": "testuser@test.com",
  "company_name": "Test Company",
  "plan_id": "plan_1"
}

Response

Document created, URL follows

idinteger required
status'success' | 'failure' | 'processing' | 'error' required

Job status can be success, failure or processing

responseobject required

Result of async task is stored in response

last_updated_atstring date-time required

Job last updated at is the time when Job status was last updated

created_atstring date-time required

Create at is time when async task was created

pathstring required

API request path of the Job operation

operationstring required

Operation is async task name which Job is tracking

Example response

{
  "response": {
    "value": {
      "response": {
        "object": "some object"
      }
    }
  }
}

Changes

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