REST API reference · Source channels

Create a business through an API source channel¶

Fetch this channel's business-contract endpoint before constructing the request body. Matching Idempotency-Key retries replay the exact committed response for at least 24 hours.

POST/source-channels/{source_channel_id}/businesses/

Parameters¶

Name	Location	Type	Required
`source_channel_id`	path	string	Yes
`Idempotency-Key`	header	string	Yes

Request body¶

The exact schema is returned by the source channel's business-contract endpoint.

View request schema

{
  "additionalProperties": true,
  "description": "The exact schema is returned by the source channel's business-contract endpoint.",
  "type": "object"
}

Request¶

curl --request POST \
  --url 'https://api.staging.levr.ai/api/external/v1/source-channels/{source_channel_id}/businesses/' \
  --header 'Authorization: Bearer $LEVR_API_TOKEN' \
  --header 'Idempotency-Key: $IDEMPOTENCY_KEY' \
  --header 'Content-Type: application/json' \
  --data '@request.json'

Responses¶

Status	Description
`201`	Business and client intake application created.
`400`	Correct the request fields and try again.
`401`	Provide a valid portal API token and try again.
`403`	This portal API token does not allow the requested action.
`404`	The requested resource was not found or is not available to this token.
`409`	The request conflicts with the resource's current state. Refresh it before trying again.
`422`	Correct the invalid values and try again.
`429`	Too many requests were sent. Wait before trying again.
`500`	Levr could not complete the request. Keep the request ID and retry when safe.