Create magic link

POST 
/magic_links

Create magic link

Request

application/json

Body

required

customer_id stringrequired
provider_name provider_namerequired

Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

return_url stringrequired

URL to redirect to after the connection is authorized.

expiration_secs numberrequired

Responses

201

Entity created

application/json

Schema

Schema

id stringrequired
status stringrequired

new or consumed

application_id stringrequired
customer_id stringrequired
provider_id stringrequired
provider_name provider_namerequired

Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

url stringrequired

The magic link URL.

return_url stringrequired

URL to redirect to after the connection is authorized.

expires_at date-timerequired

Any ISO formatted date-time string indicating when the magic link expires.

Example (from schema)

{
  "id": "ec208408-db29-4705-b39e-4d33070b4ef6",
  "status": "new",
  "application_id": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69",
  "customer_id": "my-customer-1",
  "provider_id": "677fcfca-cf89-4387-a189-71c885be67bc",
  "provider_name": "hubspot",
  "url": "https://app.hubspot.com/contacts/123456",
  "return_url": "https://app.myapp.com/connections/123456",
  "expires_at": "2023-02-23T00:00:00Z"
}

Loading...