Activate Partner

This request activates a partner.

/admin/partners/{partner_sid}/activate

Sample

A sample POST request to activate a partner:

curl -X POST \
'https://api.carrierx.com/core/v2/admin/partners/aeda835c-6627-4f4c-ac73-9edcae95640b/activate' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a serialized copy of the Partner object:

{
    "acls": [],
    "address1": null,
    "address2": null,
    "attributes": {},
    "available_scopes": [],
    "balance": "5",
    "billing_email": null,
    "brand_sid": null,
    "callbacks": {
        "sms":"https://example.com/sms-callback-url"
    },
    "charge_at": null,
    "city": null,
    "company_name": "ABC",
    "country_code": "USA",
    "daily_spending_limit": "500",
    "daily_spent_amount": "0",
    "date_created": "2024-01-22T17:16:30.844Z",
    "display_id": "CX57121051",
    "id": 6511,
    "login": "john",
    "name": "John Smith",
    "owner_email": null,
    "parent_assigned_acls": [],
    "parent_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "partner_sid": "aeda835c-6627-4f4c-ac73-9edcae95640b",
    "payment_type": "postpay",
    "phonenumber": "180045012323",
    "prepay_amount": null,
    "spending_limit": "100",
    "state": "",
    "status": "active",
    "system_attributes": {},
    "system_data": { 
        "storage.total.upload_bytes": "0", 
        "storage.total.upload_files": "0", 
        "billing.max_balance": "5" 
    },
    "tech_email": null,
    "transformations": [],
    "zip": "90804"
}

The request activates the partner with the unconfirmed status, and sends a welcome email message to the email address specified when the partner was created.

The request activates the partner with the canceled status, without sending a welcome email message.

Required Scopes

To activate a partner, the partner must have the admin.manage scope enabled.

Path Arguments

Parameter	Data Type	Description
partner_sid required	string	The partner secure ID.