/v1/contact POST

Creates a private contact

Contacts

Request URL

https://api.to.co/v1/contact?api_key={your_api_key}

Request Body

Required

Schema: ContactAddRequest

Responses

Success (200)

Schema: ContactAddResponse

{
  "contact": {
    "type": "object",
    "properties": {
      "created": {
        "type": "boolean",
        "description": "Indicates if the Contact was created"
      },
      "id": {
        "type": "string",
        "description": "The id of the Contact"
      }
    }
  },
  "request": {
    "id": "caedc1bd-a4d4-4e18-a904-bac04c31fe85",
    "success": true,
    "period_start": "2025-02-03T14:49:40.000Z",
    "next_period_start": "2025-03-03T14:49:40.000Z",
    "requests_this_period": 2000,
    "credit_available_this_period": 10000,
    "credit_used_this_request": 1,
    "credit_used_this_period": 2500,
    "credit_remaining_this_period": 7500,
    "account_id": "fddb84zz.acct.to.co",
    "subscription_id": "Az9g3fSwOBwtj2El"
  }
}

Forbidden (403)

Schema: ForbiddenError

{
  "code": 403,
  "message": "Forbidden: Invalid api_key parameter value"
}

Not Found (404)

Schema: NotFoundError

{
  "code": 404,
  "message": "Not Found: No Org exists for this domain"
}