Skip to main content
POST
Create provider connection

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_provider_connection.

name
string
required

Display name, 1..255 chars, unique within the team.

Required string length: 1 - 255
provider
enum<string>
required

custom in practice; hubspot passes the rule and is refused (its grant comes from the OAuth connect).

Available options:
custom,
hubspot
auth
object
required

WRITE-ONLY, never echoed: {key} for api_key or bearer, {username, password} for basic, {header_name, value} for header, {param_name, value} for query.

auth_type
enum<string>

Default api_key.

Available options:
api_key,
bearer,
basic,
header,
query
status
enum<string>

Default on.

Available options:
on,
off

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required