Skip to main content

Create Claim Source Connector

POST 

/api/repairs/connectors

Create Claim Source Connector.

Required scope: repairs:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request fields:

  • vendor (required): Enum:in:"aftership","loop","corso","claimlane","gorgias","form"
  • name (optional): string, max:190
  • credentials (required): array
  • push_updates (optional): boolean
  • poll_enabled (optional): boolean
  • credentials.api_key (optional): string, max:500
  • credentials.webhook_secret (optional): string, max:500
  • credentials.client_id (optional): string, max:500
  • credentials.client_secret (optional): string, max:500
  • credentials.audience (optional): string, max:500
  • credentials.data_source_id (optional): string, max:500
  • credentials.domain (optional): string, max:500
  • credentials.email (optional): string, max:500
  • credentials.sender_user_id (optional): string, max:500
  • form (optional): array
  • form.provider (optional): In:in:"typeform","jotform","hulk","generic"
  • form.field_map (optional): array
  • form.field_map.* (optional)
  • form.defaults (optional): array
  • form.defaults.warehouse_id (optional): integer, exists:warehouses,id
  • form.defaults.purchase_source (optional): Enum:in:"order","shopify","amazon","retail_store","wholesale_partner","gift","other"
  • form.defaults.inbound_method (optional): Enum:in:"customer_ships","drop_off","already_received","no_return_needed"

Permission: repairs.manage_settings. Authentication: Bearer token with the repairs:read / write scope.

Request​

Responses​

OK

Response Headers
    Content-Type