Skip to main content
POST
/
shareholders
/
{shareholderId}
/
relations
/
{relationId}
/
promote
Promote a shareholder relation
curl --request POST \
  --url https://api.syntage.com/shareholders/{shareholderId}/relations/{relationId}/promote \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "JUAN MANUEL PEREZ GONZALEZ",
  "rfc": "PEIC211118IS0",
  "datasources": [
    {
      "name": "sat"
    },
    {
      "name": "rpc"
    }
  ]
}
'
{
  "@type": "ShareholderPromotedResponse",
  "id": "91ab5678-1234-5678-9abc-def012345678",
  "name": "JUAN MANUEL PEREZ GONZALEZ",
  "rfc": "PEIC211118IS0",
  "onboardingUrl": "https://api.syntage.com/onboarding/91ab5678-1234-5678-9abc-def012345678"
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
shareholderId
string<uuid>
required

The shareholder ID

​
relationId
string<uuid>
required

The relation ID

Body

application/json
​
name
string
required

Name to use for the new promoted entity

Example:

"JUAN MANUEL PEREZ GONZALEZ"

​
rfc
string
required

RFC to use for the new promoted entity

Required string length: 12 - 13
Example:

"PEIC211118IS0"

​
datasources
object[]

Datasources to connect when creating the promoted entity

Example:
[{ "name": "sat" }, { "name": "rpc" }]

Response

Shareholder Relation promoted successfully

​
@type
string
default:ShareholderPromotedResponse
​
id
string<uuid>

ID of the created entity

Example:

"91ab5678-1234-5678-9abc-def012345678"

​
name
string

Name of the created entity

Example:

"JUAN MANUEL PEREZ GONZALEZ"

​
rfc
string

RFC assigned to the created entity

Required string length: 12 - 13
Example:

"PEIC211118IS0"

​
onboardingUrl
string | null

Onboarding URL for the created entity, when onboarding is required

Example:

"https://api.syntage.com/onboarding/91ab5678-1234-5678-9abc-def012345678"