Jump to

• Request
• Response

Create a communication send profile

post

/fscmRestApi/resources/11.13.18.05/hedCommunicationSendProfiles

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• commSendProperties: array Communication Send Properties
  Title: Communication Send Properties

  Communication send profile properties allow users to add additional properties to a send profile beyond the from address.
• FromAddress(required): string
  Title: From Address

  Maximum Length: 1000

  The from address of the send profile. This can be anything including an email or phone number.
• SendProfileCode(required): string
  Title: Send Profile Code

  Maximum Length: 36

  The alternate identifier code of a communication send profile.
• SendProfileName(required): string
  Title: Send Profile Name

  Maximum Length: 240

  The name of the communication send profile.
• SendProfileTypeCode(required): string
  Title: Send Profile Type Code

  Maximum Length: 36

  The communication send profile type code, such as ORA_HEY_EMAIL.

{
    "required":[
        "FromAddress",
        "SendProfileCode",
        "SendProfileName",
        "SendProfileTypeCode"
    ],
    "type":"object",
    "properties":{
        "FromAddress":{
            "title":"From Address",
            "maxLength":1000,
            "type":"string",
            "description":"The from address of the send profile. This can be anything including an email or phone number.",
            "nullable":false
        },
        "SendProfileCode":{
            "title":"Send Profile Code",
            "maxLength":36,
            "type":"string",
            "description":"The alternate identifier code of a communication send profile.",
            "nullable":false
        },
        "SendProfileName":{
            "title":"Send Profile Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the communication send profile.",
            "nullable":false
        },
        "SendProfileTypeCode":{
            "title":"Send Profile Type Code",
            "maxLength":36,
            "type":"string",
            "description":"The communication send profile type code, such as ORA_HEY_EMAIL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "commSendProperties":{
            "title":"Communication Send Properties",
            "type":"array",
            "description":"Communication send profile properties allow users to add additional properties to a send profile beyond the from address.",
            "items":{
                "$ref":"#/components/schemas/hedCommunicationSendProfiles-commSendProperties-item-post-request"
            }
        }
    }
}

Nested Schema : Communication Send Properties

Type: array

Title: Communication Send Properties

Communication send profile properties allow users to add additional properties to a send profile beyond the from address.

Show Source

• Array of: object hedCommunicationSendProfiles-commSendProperties-item-post-request

{
    "title":"Communication Send Properties",
    "type":"array",
    "description":"Communication send profile properties allow users to add additional properties to a send profile beyond the from address.",
    "items":{
        "$ref":"#/components/schemas/hedCommunicationSendProfiles-commSendProperties-item-post-request"
    }
}

Nested Schema : hedCommunicationSendProfiles-commSendProperties-item-post-request

Type: object

Show Source

• PropertyCode: string
  Title: Property Code

  Maximum Length: 36

  The alternate identifier code of a communication send profile property.
• PropertyTypeCode: string
  Title: Property Type Code

  Maximum Length: 30

  The communication send profile property type code, such as FROM_DISPLAY_NAME.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 1000

  The value of the communication send profile property.

{
    "type":"object",
    "properties":{
        "PropertyCode":{
            "title":"Property Code",
            "maxLength":36,
            "type":"string",
            "description":"The alternate identifier code of a communication send profile property.",
            "nullable":false
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The communication send profile property type code, such as FROM_DISPLAY_NAME.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the communication send profile property.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedCommunicationSendProfiles-item-response

Type: object

Show Source

• commSendProperties: array Communication Send Properties
  Title: Communication Send Properties

  Communication send profile properties allow users to add additional properties to a send profile beyond the from address.
• FromAddress: string
  Title: From Address

  Maximum Length: 1000

  The from address of the send profile. This can be anything including an email or phone number.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication send profile was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication send profile.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SendProfileCode: string
  Title: Send Profile Code

  Maximum Length: 36

  The alternate identifier code of a communication send profile.
• SendProfileId: integer (int64)
  Title: Send Profile ID

  Read Only: true

  The unique identifier of a communication send profile.
• SendProfileName: string
  Title: Send Profile Name

  Maximum Length: 240

  The name of the communication send profile.
• SendProfileTypeCode: string
  Title: Send Profile Type Code

  Maximum Length: 36

  The communication send profile type code, such as ORA_HEY_EMAIL.
• SendProfileTypeMeaning: string
  Title: Send Profile Type Meaning

  Read Only: true

  Maximum Length: 80

  The communication send profile type meaning, such as Email.
• UpdatableFlag: boolean
  Title: Updatable

  Read Only: true

  Indicates if a send profile can be edited or deleted.

{
    "type":"object",
    "properties":{
        "FromAddress":{
            "title":"From Address",
            "maxLength":1000,
            "type":"string",
            "description":"The from address of the send profile. This can be anything including an email or phone number.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication send profile was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication send profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SendProfileCode":{
            "title":"Send Profile Code",
            "maxLength":36,
            "type":"string",
            "description":"The alternate identifier code of a communication send profile.",
            "nullable":false,
            "x-queryable":true
        },
        "SendProfileId":{
            "title":"Send Profile ID",
            "type":"integer",
            "description":"The unique identifier of a communication send profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SendProfileName":{
            "title":"Send Profile Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the communication send profile.",
            "nullable":false,
            "x-queryable":true
        },
        "SendProfileTypeCode":{
            "title":"Send Profile Type Code",
            "maxLength":36,
            "type":"string",
            "description":"The communication send profile type code, such as ORA_HEY_EMAIL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SendProfileTypeMeaning":{
            "title":"Send Profile Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The communication send profile type meaning, such as Email.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatableFlag":{
            "title":"Updatable",
            "type":"boolean",
            "description":"Indicates if a send profile can be edited or deleted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "commSendProperties":{
            "title":"Communication Send Properties",
            "type":"array",
            "description":"Communication send profile properties allow users to add additional properties to a send profile beyond the from address.",
            "items":{
                "$ref":"#/components/schemas/hedCommunicationSendProfiles-commSendProperties-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Communication Send Properties

Type: array

Title: Communication Send Properties

Communication send profile properties allow users to add additional properties to a send profile beyond the from address.

Show Source

• Array of: object hedCommunicationSendProfiles-commSendProperties-item-response

{
    "title":"Communication Send Properties",
    "type":"array",
    "description":"Communication send profile properties allow users to add additional properties to a send profile beyond the from address.",
    "items":{
        "$ref":"#/components/schemas/hedCommunicationSendProfiles-commSendProperties-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedCommunicationSendProfiles-commSendProperties-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PropertyCode: string
  Title: Property Code

  Maximum Length: 36

  The alternate identifier code of a communication send profile property.
• PropertyTypeCode: string
  Title: Property Type Code

  Maximum Length: 30

  The communication send profile property type code, such as FROM_DISPLAY_NAME.
• PropertyTypeMeaning: string
  Title: Property Type Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the communication send profile property type code, such as From Address or Display Address.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 1000

  The value of the communication send profile property.
• SendPropertyId: integer (int64)
  Title: Send Property ID

  Read Only: true

  The unique identifier of a communication send profile property.

{
    "type":"object",
    "properties":{
        "PropertyCode":{
            "title":"Property Code",
            "maxLength":36,
            "type":"string",
            "description":"The alternate identifier code of a communication send profile property.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The communication send profile property type code, such as FROM_DISPLAY_NAME.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PropertyTypeMeaning":{
            "title":"Property Type Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the communication send profile property type code, such as From Address or Display Address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the communication send profile property.",
            "nullable":true,
            "x-queryable":true
        },
        "SendPropertyId":{
            "title":"Send Property ID",
            "type":"integer",
            "description":"The unique identifier of a communication send profile property.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

commSendProperties

Operation: /fscmRestApi/resources/11.13.18.05/hedCommunicationSendProfiles/{SendProfileId}/child/commSendProperties

Parameters:

• SendProfileId: $request.path.SendProfileId

Communication send profile properties allow users to add additional properties to a send profile beyond the from address.

heyLookupsSendProfileTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_COMM_CHANNEL%2CLookupCode%3D{SendProfileTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: SendProfileTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top